Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Prerequisites
- NodeJS ( Version Greater Than 8 )
- An Active Internet Connection
- If Using Windows,
node-gyp
installed without any errors - Git Installed
Installing
-
First Clone The Repository using:
git clone https://github.com/ionadev/image-gen-api.git
-
Then Navigate to
your/path/image-gen-api-master
. -
Run if using
npm
:npm install
or if
yarn
:yarn
Running
- After Installing, run:
-
If Using
npm
:npm start
-
If Using
yarn
:yarn start
-
Built With
- Express - Web framework Used.
- Body-Parser - A Middleware For Express.
- Cors - A Middleware for Express.
- Canvas - The Module For Generating Images.
- node-superfetch - A Module Used For Fetching Images, etc.
Authors
- Piyush Bhangale - Initial Work, Idea, Main Contributor, Owner - ionadev
- Anish Shobith - Contributor,Readme - Anish-Shobith