https://github.com/pitu/api-starter

https://github.com/pitu/api-starter

Last synced: 6 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/pitu/api-starter
• Owner: Pitu
• Created: 2019-03-18T04:53:44.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-11T01:21:54.000Z (about 3 years ago)
• Last Synced: 2024-05-01T14:18:21.912Z (over 1 year ago)
• Language: JavaScript
• Size: 767 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://raw.githubusercontent.com/kanadeko/Kuro/master/LICENSE)

[![Chat / Support](https://img.shields.io/badge/Chat%20%2F%20Support-discord-7289DA.svg?style=flat-square)](https://discord.gg/5g6vgwn)

[![Support me](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2Fpitu&style=flat-square)](https://www.patreon.com/pitu)

[![Support me](https://img.shields.io/badge/Support-Buy%20me%20a%20coffee-yellow.svg?style=flat-square)](https://www.buymeacoffee.com/kana)

### Pre-requisites

This guide asumes a lot of things, including that you know your way around linux, nginx and internet in general.

- Decently updated version of linux

- `node` package installed and at least at version 10

- `build-essential` package installed to build some dependencies

- `yarn` package installed. If you'd like to use npm instead change `package.json` accordingly

- A database, postgresql preferably. You can also fall back to sqlite3 by default.

### Installing

1. Clone the repository and `cd` into it

2. Run `yarn install`

3. Run `yarn setup`

4. Run `yarn start`

5. Profit

## Author

**API Starter** © [Pitu](https://github.com/Pitu), Released under the [MIT](https://github.com/Pitu/API-starter/blob/master/LICENSE) License.


Authored and maintained by Pitu.

> GitHub [@Pitu](https://github.com/Pitu)