Freebee

It's a map based web-application designed to navigate over free facilities of city (simply put, freebies).

• Small VK public page;
• Freebee at Social Weekend Hackathon.

Getting started

Clone project to your computer.

$ git clone https://github.com/FreebeeTeam/freebee-api.git

Prerequisites

To start with Freebee API, you should have Node installed.

Installing

Install all dependencies.

$ npm install

To launch Freebee API you should create .env file in a root directory. File should contain:

PORT = 4000
MONGODB_CONNECTION =
MONGO_DB_NAME =

HERE_ROUTE_API =
HERE_APP_ID =
HERE_APP_CODE =

AUTH0_DOMAIN =
AUTH0_API_IDENTIFIER =
AUTH0_CLIENT_ID =

• MONGODB_CONNECTION - a MongoDB connection string with credentials;
• AUTH0_DOMAIN - Auth0's server location, could be found here;
• AUTH0_API_IDENTIFIER - friendly name for app API, could be changed in APIs tab of Auth0 Dashboard.

To run server on localhost type npm start in root folder.

$ npm start

Deployment

To deploy with Heroku, visit official guide page.

Briefly:

$ heroku login
Enter your Heroku credentials.
$ heroku create
$ git push heroku master

Ensure the app is running.

heroku ps:scale web=1
heroku open

Built With

• Node.js - JavaScript runtime for server;
• npm - Package manager for JavaScript;
• Express.js - Framework for Node.js.

Deployment

• Heroku - Deployment platform for testing needs.

Database

• MongoDB - NoSQL Database;
• Mongoose - ODM for MongoDB.

Hints

Some advices that can save your time 💡

• Your project should provide a Procfile when you deploy to Heroku.

Developed by

• Егор Пуйша - GitStearis;
• Артем Дадыченко - ArtemDadychenko;