- Features
- Packages
- Quick Setup Guide
- Projects using this Template
- Reporting a Bug or Issue
- Contributing
- License
Reason for this project/template
- A cool feature
TBD
Package | Description | Links |
---|---|---|
A package | A description | Website, Docs |
- Git, for cloning and interacting from GitHub
Clone the project from Github, locally using
git clone https://github.com/Fableverse/api-template.git
Run NPM install from your terminal
npm i
If you are planning to use mongodb, you will need to create a .env
file at the root of the codebase, with the following:
# Set to production when deploying to production
NODE_ENV=development
# Node.js server configuration
PORT=8000
# MongoDB configuration
MONGO_CONNECTION_STRING=mongodb://localhost:27017/testing
The mongodb connection will have to be changed depending on where you have it hosted, let it be locally or in the cloud. Right now, this is pointed to a local mongo database.
To run the project, run:
npm start
To run the jest tests in the project, run:
npm test
Create a new Issue directly in this repository utilizing the "Bug Report" template.
For issues related to security or vulnerabilities, please do not create an issue. Instead, reach out to security@fableverse.com with all the details around reproducing it, screenshots, and any other useful information.
Please reference the Code of Conduct for this repository.
When you are looking to contribute new code, you will want to create a fork for the changes, and than create a pull request into the original repository. More information on that process can be found here.
Copyright © 2022 Fableverse
This project is GPL licensed.