Git-Rekt SE Project

Awards

• GUC SE Course 2017 #1 Team Overall
  
• GUC SE Course 2017 #1 Team Education Theme

Demo

Live Demo

https://git-rekt.me/

Facebook Bot with NLP

https://www.facebook.com/Git-Rekt-233623487117867/

---

Setup

1. Clone this repo to your desktop git clone https://github.com/melzareix/git-rekt-se.git
2. Run npm install to install all the dependencies.
3. Create a MongoDB title gitrekt_db.
4. Create .env file with the following constants:
   • PORT, The port number to run the project.
   • HTTPS_PORT, The port number to run the project with SSL.
   • JWT_KEY_CLIENT, The secret key used to sign Client JWT Tokens.
   • JWT_KEY_BUSSINES, The secret key used to sign Business JWT Tokens.
   • JWT_KEY_ADMINISTRATOR, The secret key used to sign Admin JWT Tokens.
   • DB_URL, The URL to MongoDB database.
   • SEND_GRID, Your Send Grid API Key used to set reset password link.
   • FB_APP_ID, Facebook Application ID.
   • FB_APP_SECRET, Facebook Application Secret.
   • FB_CALLBACK, Facebook Callback link http://localhost:3000/api/v1/client/auth/fb/callback.
   • DEBUG_MODE, SET to 1 to enable debugging middlewares.
   • ADD_DELAY, SET to 1 to add delay to requests for testing.
   • BOT_BASE,FB_VERIFY_TOKEN,PAGE_ACCESS_TOKEN,API_AI_TOKEN Tokens required for our facebook bot.
5. Add app/certs folder, with your private and cert key from letsencrypt.
6. If you are the testing team please send an email to mohamedelzarei[at]gmail.com for our actual .env file and certificates.

---

Usage

Run npm start to start in production mode, npm run debug to run using nodemon in debug mode.

---

Bugs

If you found a bug, please report it through the issues tab.

---

Docs

Project Backlog

https://docs.google.com/spreadsheets/d/1orzeXUjwjDFbxvn4TYuPaiVZYd2Iu7tV-IH4PqYPTmU/edit?usp=sharing

API Documentation

API V1 Documentation [Partial Documentation] https://gitrekt-se.restlet.io/

---

License

You can check out the full license here

This project is licensed under the terms of the MIT license.