https://github.com/gadfaria/express-sequelize-boilerplate
Boilerplate for express.js.
https://github.com/gadfaria/express-sequelize-boilerplate
aws-s3 boilerplate express express-sequelize-boilerplate jwt sequelize
Last synced: about 1 month ago
JSON representation
Boilerplate for express.js.
- Host: GitHub
- URL: https://github.com/gadfaria/express-sequelize-boilerplate
- Owner: gadfaria
- License: mit
- Created: 2020-06-21T06:44:45.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-10-28T02:36:25.000Z (4 months ago)
- Last Synced: 2025-10-30T21:43:48.351Z (4 months ago)
- Topics: aws-s3, boilerplate, express, express-sequelize-boilerplate, jwt, sequelize
- Language: JavaScript
- Homepage:
- Size: 473 KB
- Stars: 92
- Watchers: 1
- Forks: 21
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# express-sequelize-boilerplate
This is a simple boilerplate for building REST APIs in Node.js using Express. Intended for use with PostgreSQL using Sequelize ORM.
## Getting Started
Clone the repository
```bash
git clone https://github.com/gadfaria/express-sequelize-boilerplate.git
```
Enter into the directory
```bash
cd express-sequelize-boilerplate/
```
Install the dependencies
```bash
yarn
```
Set the environment variables
```bash
cp .env.example .env
```
Running the boilerplate:
```bash
yarn dev
```
## Configuration
Variables for the environment
| Option | Description |
| ------ | ------ |
| SERVER_PORT | Port the server will run on |
| NODE_ENV | development or production |
| SERVER_JWT | true or false |
| SERVER_JWT_SECRET | JWT secret |
| SERVER_JWT_TIMEOUT | JWT duration time |
| DB_DIALECT | "mysql", "postgresql", among others |
| DB_HOST | Database host |
| DB_USER | Database username |
| DB_PASS | Database password |
| DB_NAME | Database name |
| AWS_KEYID | Access key ID |
| AWS_SECRETKEY | User secret key |
| AWS_BUCKET | Bucket name |
## Commands for sequelize
```bash
# Creates the database
yarn sequelize db:create
# Drops the database
yarn sequelize db:drop
# Load migrations
yarn sequelize db:migrate
# Undo migrations
yarn sequelize db:migrate:undo:all
# Load seeders
yarn sequelize db:seed:all
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License
[MIT](https://choosealicense.com/licenses/mit/)
☕ Code and Coffee