https://github.com/nekonyadevs/backend

NekoNya's Backend, built with Express 4
https://github.com/nekonyadevs/backend

api backend expressjs javascript

Last synced: 5 days ago
JSON representation

NekoNya's Backend, built with Express 4

• Host: GitHub
• URL: https://github.com/nekonyadevs/backend
• Owner: NekoNyaDevs
• License: gpl-3.0
• Created: 2023-03-12T16:22:31.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-02T19:04:09.000Z (4 months ago)
• Last Synced: 2024-11-20T23:51:42.640Z (2 months ago)
• Topics: api, backend, expressjs, javascript
• Language: TypeScript
• Homepage: https://nekonya.classydev.fr
• Size: 202 KB
• Stars: 3
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🌿・NekoNya-Backend

## 📝・Description

NekoNya-Backend is a Node.JS TypeScript webserver running the API behind the scenes.

If you wish to deploy your own instance of NekoNya-Backend for any reasons, you can do so by following the instructions below. But please, do not forget to give credit to the original authors of this project.

## 📚・How to deploy

### 📦・Install

```bash

$ git clone https://github.com/NekoNyaDevs/backend.git

$ cd backend

$ npm install

```

> Note: You need to have [Node.js](https://nodejs.org/en/) and [TypeScript](https://www.typescriptlang.org) installed.

### 📝・Configuration

Change the file `src/config.example.ts` to `config.ts` and change the values to your liking. The configuration file is commented so you can easily understand what each value does.

Don't forget to add images in the categories inside the `images` folder.

### 🚀・Run

Production:

```bash

$ npm start

```

Development:

```bash

$ npm run dev

```

## 📜・License

This project is licensed under the GNU GPL 3.0 License - see the [LICENSE](LICENSE) file for details