https://github.com/guoyunhe/adonis-api-template
RESTful API server template with AdonisJS
https://github.com/guoyunhe/adonis-api-template
Last synced: 3 months ago
JSON representation
RESTful API server template with AdonisJS
- Host: GitHub
- URL: https://github.com/guoyunhe/adonis-api-template
- Owner: guoyunhe
- Created: 2022-11-11T14:46:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-03T15:16:37.000Z (almost 2 years ago)
- Last Synced: 2025-01-10T17:40:06.467Z (5 months ago)
- Language: TypeScript
- Size: 315 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AdonisJS RESTful API Server
## Local Development
System requirements:
- Docker
- Git
- Node.js 16+
First, you need to fork and clone the git repository.
Then run the following commands:
```bash
# start docker containers for mysql, etc.
docker compose up
# configure environment variables
cp .env.example .env
# install dependencies
npm install
# migrate database schema
node ace migration:run
# start server with auto-reload
node ace serve --watch
```
If remote source code was changed, run above commands again to update your local project.
## Production Deployment
System requirements:
- GNU/Linux
- Systemd, included in most modern GNU/Linux distributions
- Node.js 16+
- MySQL/MariaDB/Postgres
- Python 3
- [Certbot](https://certbot.eff.org/)
Initial deployment (Linux):
```bash
# generate https certificates
sudo certbot certonly
# configure environment variables
cp .env.example .env
vi .env
# install dependencies
npm install
# migrate database structure
node ace migration:run
# build the server
node ace build --production
# daemon process manager to keep your app always online
sudo npm i -g pm2
pm2 startup
pm2 start pm2.config.js
pm2 save
```
Regular update:
```bash
# install dependencies
npm install
# migrate database structure
node ace migration:run
# build the server
node ace build --production
# restart daemon process
sudo systemctl restart pm2-root
```
## API
### Authentication
#### POST /login
Body:
```ts
interface RequestData {
name: string;
email: string;
password: string;
}
```
#### POST /register
## Documentation
- [adonis-api-template](https://github.com/guoyunhe/adonis-api-template) - the template
- [AdonisJS](https://docs.adonisjs.com/) - the framework
- [PM2](https://pm2.keymetrics.io/) - the daemon process manager
- [Certbot](https://certbot.eff.org/) - get free HTTPS certificates
## About The Template
This app is generated from https://github.com/guoyunhe/adonis-api-template
Issues and pull requests are always welcome.
Looking for a front-end template, too? Checkout https://github.com/guoyunhe/react-app-template