killax-d / passionly-api

Passionly API work with Passionly Web Client

Passionly-API

API made for Passionly project!

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• License
• Contact

About The Project

Built With

• NodeJS
• ExpressJS
• JWT

Getting Started

Prerequisites

To run this project, you will need:

• npm

npm install npm@latest -g

• postgres

Installation

1. Clone the repo

git clone https://gitlab.univ-artois.fr/dylan_donne/passionly-api

2. Install NPM packages

npm install

3. Create a config.js in /config folder

const db_config = {
  user: 'passionly',
  host: 'localhost',
  database: 'api',
  password: 'password',
  port: 5432
}

const app_config = {
  http_port: 3000,
  https_port: 8443
}

const auth_config = {
  secret: "itsasecret"
}

module.exports = {
  db_config,
  app_config,
  auth_config
}

4. Create a Firebase APP and download the serviceAccountKey.json to the root folder
5. Build api bundle

npm run build

6. API is ready to be published ! Enjoy

Usage

This API has been specially designed for Passionly Client.

License

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

Contact

DONNE Dylan - @Killax_Dev - [email protected]