Ose-4g/image-repository

Image Repository

An API for users to upload images and search through the images.
It has both REST and GraphQL architecture. The API is dpeloyed at https://ose4g-image-repository.herokuapp.com/
To use the api look through the documentation

Getting started

Prerequisites

• Node v14.x
• npm >= 6.14
• Git installed

Running Locally

• Clone the repository. Run the following in your terminal

$ git clone https://github.com/Ose-4g/image-repository.git
$ cd image-repository
$ npm install

• In the root directory of the project create a .env file and copy the values from .env.sample and set the values of the veriables correctly.
• To run locally you'll need
  • URI to a mongoDB server running locally or in the cloud
  • AWS config keys for an AWS s3 Bucket.
• To run locally after setting the environment variables correctly.
  • To run in development mode

  $ npm run dev

  • To run in production mode
  • set NODE_ENV in your .env to production
  • Run in your terminal

  $ npm run build
  $ npm start

To access the graphql go to /graphql