• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Installation
  • Environmental Variables
  • Running
• Testing
  • Running Unit Tests
• API Documentation
• Functional Documentation
• Roadmap
• Contributing
• License
• Contributers

Chat Application API with Node.js Express for Chato Front End

https://chato-api.herokuapp.com/api/v1/

• Node.js
• Express
• Jest
• MongoDB

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

1. Clone the repo

git clone https://github.com/D4rk1n/Chato-Back-End.git

2. Install dependencies

npm install

For developers, you can directly use our development.json located in config\development.json or modify it if you like.

For production, you need to make your own config\production.json with the following structure.

{
 "JWT_KEY": "foo",
 "JWT_EXPIRES_IN": "30d",
 "SENDGRID_API_KEY": "SG.1",
 "NODE_ENV": "production",
 "db": "mongodb://localhost:27017/chato",
 "PORT": "3001"
}

• JWT_KEY: Your json web token secret key.
• JWT_EXPIRES_IN: The period token can last before expiring expressed in seconds or a string describing a time span

  Eg: 60, "2 days", "10h", "7d". A numeric value is interpreted as a seconds count. If you use a string be sure you provide the time units (days, hours, etc), otherwise milliseconds unit is used by default ("120" is equal to "120ms").

• db: Your database path

  Eg: "mongodb://localhost:27017/YourCollection" If you're hosting on your localhost server.

• PORT: Your api hosting port
• NODE_ENV: It must be "production" in order to run the api on production otherwise use config\development.json

1. Running on development

npm run start-dev

2. Running on production

Upon creating config\production.json like in Environmental Variables section. run this script:

npm start

The tests can be found in tests, and each controller has its own test file in tests\unit\controller. Mongoose models tests are also found in tests\unit\models as well as middleware which is located at tests\unit\middlewares.

run the following script:

npm test

install the latest version on npm globally (might require sudo if you are on linux):

npm install -g jsdoc

in order to generate the documentation, run the jsdoc command:

jsdoc -r ./src

By default, the generated documentation is saved in a directory named out. You can use the --destination (-d) option to specify another directory.

See the open issues for a list of proposed features (and known issues).

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b AmazingFeature-Feat)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin AmazingFeature-Feat)
5. Open a Pull Request

Distributed under the MIT License. See LICENSE for more information.

Abdelrahman Tarek

Abdelrahman Arafat

Hassan Mohamed