https://github.com/seedyrom/node-sequelize-api
An example project using NodeJS, Express and Sequelize
https://github.com/seedyrom/node-sequelize-api
expressjs nodejs sequelize
Last synced: about 2 months ago
JSON representation
An example project using NodeJS, Express and Sequelize
- Host: GitHub
- URL: https://github.com/seedyrom/node-sequelize-api
- Owner: SeedyROM
- Created: 2019-04-14T09:53:43.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-04-15T10:34:10.000Z (about 7 years ago)
- Last Synced: 2025-05-16T20:07:47.552Z (about 1 year ago)
- Topics: expressjs, nodejs, sequelize
- Language: JavaScript
- Size: 109 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
SimpleAPI (node, express, sequelize)
This is a project to create a sane boilerplate for integrating SQL databases and express.
Mostly a learning tool for me, so take this as is.
## Overview
This project is my attempt at making a semi sane boilerplate working with RDBMS' in Node. It also includes tools / helpers to create an example REST api with JWT authentication. *(JWT is not implemented yet)*
### Databases used per environment:
* SQLite for `development`
* SQLite in memory for `test`
* Any adapter for `production`, this is specified in the `config/config.js` file, default is `postgres`
## Getting started
* Clone this repository:
* `git clone https://github.com/SeedyROM/node-sequelize-api`
* or to rename it something else `git clone https://github.com/SeedyROM/node-sequelize-api myproject`
* Then change directories (`cd`) into the cloned repo
* Run `yarn install` or just `yarn` to install dependencies
* Migrate the initial example migrations into the local sqlite development database:
* `yarn run sequelize db:migrate`
* You can use `yarn run sequelize ...` to call any `sequelize-cli` commmand you need
* Then run `yarn start` to start a local development server
## Contributing
1. Fork it ( https://github.com/SeedyROM/node-sequelize-api/fork )
2. Create your feature branch (git checkout -b feature/my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin feature/my-new-feature)
5. Create a new Pull Request
## Contributors
- [SeedyROM](https://github.com/SeedyROM) Zack Kollar - creator, maintainer