ARC(Animal Rescue Community)- BACKEND

Raising Hands For Injured Paws

ARC is a non-profit organization which helps orphan pets find their new homes and a family.

Contents

• Stack
• Setup Guide
• Contribution Guide
• Community
• Support
• License
• Maintainers

Stack

Stack	Technology
Backend	Nodejs , expressjs
Database	MongoDB

Setup Guide

Basic requirements

 Install Node version 14 or higher
 Install MongoDB

• Fork this repository into your own GitHub account.

• Clone the repo from your GitHub account to your local machine using the following commands

• you can either use ssh or https

using https:
$ git clone https://github.com/arc-pune/arc-backend.git
$ cd arc-backend

or

using ssh:
$ git clone git@github.com:arc-pune/arc-backend.git
$ cd arc-backend

• Creating branch

git branch  your-branch-name
git checkout your-branch-name

• Configuring env file
  • create a .env file in the root directory
  • set the MongoDb url in the env file
  • you can refer to the .env.example file

To run the development server, do the following in the arc-backend directory:

##Non-Docker Version

$ npm install
$ npm run dev

##Docker Version

$ npm install && npm dockerize

You can now see the project running on your localhost

You can edit files on your text-editor, changes will be reflected in your browser.

Contribution Guide

• Go to Contributing.md

Community

We also have public chat rooms on Discord. Drop by and say hello!

Support

If you have any feature requests or bug reports, please log them on the issue tracker.

License

This project is licensed under the MIT License.

Primary Maintainers

Anand

Kishore

Sahil