Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anthonybudd/express-api-boilerplate
A very simple REST API boilerplate using Express.js, Sequelize and MySQL.
https://github.com/anthonybudd/express-api-boilerplate
api express mysql node rest sequelize
Last synced: about 2 months ago
JSON representation
A very simple REST API boilerplate using Express.js, Sequelize and MySQL.
- Host: GitHub
- URL: https://github.com/anthonybudd/express-api-boilerplate
- Owner: anthonybudd
- License: mit
- Created: 2021-11-17T20:49:15.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-17T18:27:31.000Z (7 months ago)
- Last Synced: 2024-06-17T20:39:59.423Z (7 months ago)
- Topics: api, express, mysql, node, rest, sequelize
- Language: JavaScript
- Homepage:
- Size: 935 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Express API Boilerplate
## ⚠️ I have stopped maintaining this repo in favor of the new [TypeScript version](https://github.com/anthonybudd/express-ts-api-boilerplate)
A very mimimal REST API boilerplate using Express.js, Sequelize and MySQL.
This project is designed to work with [AnthonyBudd/Vuetify-SPA-Boilerplate](https://github.com/anthonybudd/Vuetify-SPA-boilerplate)
- 👥 Users, Groups and Roles
- 🔐 Auth using JWT's with Passport.js
- 🌐 Production-ready [OpenApiSpec.yml](./OpenApiSpec.yml) & [Kubernetes files](./k8s)
- 🥇 Real-world tested, generated over $50M in revenue
```sh
git clone [email protected]:anthonybudd/express-api-boilerplate.git
cd express-api-boilerplate
cp .env.example .env
# Optional: Find & Replace (case-sensaive, whole repo): "express-api" => "your-api-name"
LC_ALL=C find . -type f -name '*.*' -exec sed -i '' s/express-api/your-api-name/g {} +
# Private RSA key for JWT signing
openssl genrsa -out private.pem 2048
openssl rsa -in private.pem -outform PEM -pubout -out public.pem
# Start the app
npm install
docker compose up
npm run _db:refresh
npm run _test
# Code generation
npm run generate -- --model="Book"
npm run _test
# Edit models interactivly
npm run edit --model="User" --id="c4644733-deea-47d8-b35a-86f30ff9618e"
```
### DB Structure
The DB structure is the optimum balance of functionality and minimalism. A User can belong to many Groups through the GroupsUsers table. This allows you to make very basic single-user applications that do not even require the concept of groups or full SaaS solutions with complex User-Group relationships.
```
+--------------+ +---------------+ +--------------+
|Users | --------∈ |GroupsUsers | ∋------ |Groups |
|--------------| |---------------| |--------------|
|id | |id | |id |
|email | |groupID | |name |
|password | |userID | |ownerID |
|firstName | |createdAt | |createdAt |
|lastName | +---------------+ |updatedAt |
|createdAt | +--------------+
|updatedAt |
|... |
+--------------+
```
### Routes
| Method | Route | Description | Payload | Response |
| ----------- | -------------------------------------------------------- | ------------------------------------- | ------------------------------------- | ----------------- |
| **DevOps** | | | | |
| GET | `/_readiness` | Kuber readiness check | -- | "healthy" |
| GET | `/api/v1/_healthcheck` | Returns {status: 'ok'} if healthy | -- | {status: 'ok'} |
| **Auth** | | | | |
| POST | `/api/v1/auth/login` | Login | {email, password} | {accessToken} |
| POST | `/api/v1/auth/sign-up` | Sign-up | {email, password, firstName, tos} | {accessToken} |
| GET | `/api/v1/auth/verify-email/:emailVerificationKey` | Verify Email | -- | {success: true} |
| POST | `/api/v1/auth/forgot` | Forgot | {email} | {success: true} |
| GET | `/api/v1/auth/get-user-by-reset-key/:passwordResetKey` | Get user for given `passwordResetKey` | -- | {id, email} |
| POST | `/api/v1/auth/reset` | Reset Password | {email, password, passwordResetKey} | {accessToken} |
| GET | `/api/v1/auth/get-user-by-invite-key/:inviteKey` | Get user for given `inviteKey` | -- | {id, email} |
| POST | `/api/v1/auth/invite` | Complete user invite process | {inviteKey, email, password, ...} | {accessToken} |
| GET | `/api/v1/_authcheck` | Returns {auth: true} if has auth | -- | {auth: true} |
| **Groups** | | | | |
| GET | `/api/v1/groups/:groupID` | Returns group by ID | -- | {Group} |
| POST | `/api/v1/groups/:groupID` | Update group by ID | {name: 'New Name'} | {Group} |
| POST | `/api/v1/groups/:groupID/users/invite` | Invite user to group | {email} | {UserID, GroupID} |
| DELETE | `/api/v1/groups/:groupID/users/:userID` | Remove user from group | -- | {UserID} |
| **User** | | | | |
| GET | `/api/v1/user` | Get the current user | | {User} |
| POST | `/api/v1/user` | Update the current user | {firstName, lastName} | {User} |
| POST | `/api/v1/user/update-password` | Update password | {password, newPassword} | {success: true} |
### Deployment
Full Kubernetes deployment instructions can be found in [k8s/Deploy.md](./k8s/Deploy.md).
- [api.deployment.yml](./k8s/api.deployment.yml)
- [api.service.yml](./k8s/api.service.yml)
- [api.ingress.yml](./k8s/api.ingress.yml)
```sh
kubectl apply -f .k8s/api.deployment.yml \
-f .k8s/api.ingress.yml \
-f .k8s/api.service.yml
```
### Code Generation
There is a very rudimentary code generation script that will create 5 files for you; a model, router, migration, seeder and a test. Input your model name using the `--modelName` argument as PascalCase or camelCase. Use `-v` for verbose output and `-d` for a dry run.
```sh
npm run generate -- --modelName="ModelNameAsPascalCase"
```
### Generate SDK Client Libraries
There is an [OpenAPISpec](./OpenApiSpec.yml) in the root of the repo. The project includes code generation config files for PHP, JavaScript and Swift. Use the below command to generate SDK Client Libraries for your API to `/sdk/dist`. A full list of supported langauages [can be found here.](https://github.com/OpenAPITools/openapi-generator?tab=readme-ov-file#overview)
```sh
docker run --rm \
-v ${PWD}:/app \
-w /app \
openapitools/openapi-generator-cli batch sdk/config/*.yaml
```
### Commands
There are a few helper scripts and commands for interacting with the application.
Some commands need to be run inside the docker container, these commands have been aliased with an underscore prefix, for exmaple `npm run _db:refresh` is an alias for `docker exec -ti express-api npm run db:refresh` which actually runs `./src/scripts/refresh`
| Command | Description | Exmaple |
| --------------------- | ----------------------------- | -------------------------------- |
| generate | Code generation | `npm run generate -- --model="book"` |
| get | Get a model | `npm run get --model="User" --id="c4644733-deea-47d8-b35a-86f30ff9618e"` |
| edit | Interactive model editing | `npm run edit --model="User" --id="c4644733-deea-47d8-b35a-86f30ff9618e"` |
| pkg | Compile app | `npm run pkg` |
| jwt.js | Generate JWT for a user | `docker exec -ti express-api node ./src/scripts/jwt.js --userID="c4644733-deea-47d8-b35a-86f30ff9618e"` |
| forgotPassword.js | Generate password reset link | `docker exec -ti express-api node ./src/scripts/forgotPassword.js --userID="c4644733-deea-47d8-b35a-86f30ff9618e"` |
| resetPassword.js | Password user password | `docker exec -ti express-api node ./src/scripts/resetPassword.js --userID="c4644733-deea-47d8-b35a-86f30ff9618e" --password="password"` |
| inviteUser.js | Invite user to group | `docker exec -ti express-api node ./src/scripts/inviteUser.js --email="[email protected]" --groupID="fdab7a99-2c38-444b-bcb3-f7cef61c275b"` |