https://github.com/ardier16/grate-api

[Work in progress] Server side of the gRate social network
https://github.com/ardier16/grate-api

express grate mongodb nodejs rest-api server social-network

Last synced: 12 months ago
JSON representation

[Work in progress] Server side of the gRate social network

• Host: GitHub
• URL: https://github.com/ardier16/grate-api
• Owner: ardier16
• License: gpl-3.0
• Created: 2019-02-13T21:01:43.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-03T19:16:16.000Z (over 3 years ago)
• Last Synced: 2023-03-02T17:36:27.739Z (over 3 years ago)
• Topics: express, grate, mongodb, nodejs, rest-api, server, social-network
• Language: JavaScript
• Size: 1.64 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# gRate API 

![GitHub repo size](https://img.shields.io/github/repo-size/ardier16/grate-api.svg?label=size)

![David](https://img.shields.io/david/ardier16/grate-api.svg)

![GitHub commit activity](https://img.shields.io/github/commit-activity/m/ardier16/grate-api.svg?style=popout)

The server side of the gRate social network

## How to run

### Clone the repository

Using SSH: `git clone git@github.com:ardier16/grate-api.git`

or

Using HTTPS: `git clone https://github.com/ardier16/grate-api.git`

### Prepare the environment

#### Install [Node.js & npm](https://nodejs.org)

#### Install [MongoDB](https://www.mongodb.com/)

#### Install Yarn

Run `npm install -g yarn`

#### Install all the dependencies

Go to the project folder and run `yarn` or `yarn install`

### Create the configuration file

Go to `/src` folder and create a file `config.js`:

````js

export default {

  // Secret key for encrypting the tokens

  secret: 'YOUR_SECRET_KEY',

  // MongoDB connection string

  dbConnectionString: 'mongodb://127.0.0.1:27017/grate_db',

  // Default application port

  port: 8080,

}

````

### Start the project

Run `yarn start`