Hobbe Backend Server

Features

• Node JS
• Socket IO
• MongoDB
• Expo Server SDK
• Passport JS
• Babel
• Nodemon

... and many more, check the package.json file for all the libraries used.

Prerequisites

• A comfortable development enviroment
• Node v10.16.0 (it is recommended to install it via NVM)
• NPM or Yarn

Installation

Following this assumes you have everything setup, to install the project either download the .zip file and extract or navigate to an empty directory and clone this repo:

git clone https://github.com/AbdeenM/hobee-backend.git

Once you have the project files downloaded navigate to where the package.json file is in your directory and run npm install or yarn install depending on what you have as a package manager.

Getting Started

1. Modify constants/config.js with your details respectively.

• SERVER_URL: place your current servers url.
• DB)URL: you can leave this as is or modify the "hobee" string to whatever you like. (This is the name of your db).
• JWT_SECRET: you can leave this as is or modify it. (This is your passport secret, can be any random string).

2. Run npm run build:watch on the project root directory, to build your dist/ file which will be your compiled source code
3. Run on a new terminal instancec npm run dev on your project root directory, to run the server.
4. Now sit back relax and enjoy exploring the application!

Note: On a production enviroment you can use PM2 to manage your application (Highly Recommended!)

Project Status

This project has great potential for improvements, currently i wont be updating or modifying it due to time shortage but feel free to contribute!

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.

License

Hobee © 2018+, Released under the MIT License

Authored and Maintained by Abdeen Mohamed