satnami / software-engineering-daily-api

Backend API for Software Engineering Daily

SEDaily-API

The backend services and API for the Software Engineering Daily Android, iOS, and web front end.

Set up (local)

*More details here...

• Install and run a local redis client
• Install and run a local mongo client
• cp .env.local_example .env
• npm install or yarn install
• npm start or yarn start
• check package.json for other builds
• use curl or Postman to make requests
• view swagger api docs at HOST/api/docs

Using Docker

• cp .env.docker_example .env
• Run docker-compose up
• If dependencies are updated in package.json, run docker-compose down and then docker-compose up --build. This will remove the old container and rebuild the API image which installs the new dependencies.