The powerful official REST API of the Fyllee content-hosting platform!
Written in TypeScript with Nest.js, this REST API allows you to login to your account, create and manage your applications, and create and manage your contents within your applications.
This GitHub repository is where we develop the Fyllee REST API! You can take a look at the web app repository at fyllee-ui.
To install Fyllee, clone the GitHub repository and install the Node.js modules. Then create a .env file.
$ git clone https://github.com/fyllee/fyllee.git fyllee
$ cd fyllee
$ npm install
$ cp .env.example .envYou can then fill in your personnal information in the .env file.
When this is done, launch Postgres with docker-compose. This will also launch pgadmin on localhost:8080.
$ docker-compose upFinally, create the database and generate the schemas with MikroORM:
$ npx mikro-orm schema:create --runYou can launch Fyllee either in development mode or in production mode. The API will be launched on localhost:5000,
unless you add PORT=your port in the your environment variables.
You must use Node.js v12+ or v14+, but not v15 (or odd-numbered versions in general). The app has not been tested
Node.js v16+ yet.
Development
You can use the start:dev (or dev) script to launch the app. It will automatically recompile whenever you save a
file.
$ npm run start:dev # or npm run devProduction
$ npm run startTest
$ npm run lint # Run linting tests (append ":fix" to automatically fix most of the errors)
$ npm run test # Run unit tests (append ":watch" to automatically restart them when a file is saved)
$ npm run test:e2e # Run end-to-end tests
$ npm run test:cov # Run coverage tests
$ npm run test:all # Run all tests, except coverageCopyright © 2021 Elliot Maisl & Mathis Le Bonniec. Licensed under the Apache-2.0 license, see the license.