Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atb00ker/pern-init
Template for ProgreSQL-Express-React-Node CRUD application.
https://github.com/atb00ker/pern-init
Last synced: about 2 months ago
JSON representation
Template for ProgreSQL-Express-React-Node CRUD application.
- Host: GitHub
- URL: https://github.com/atb00ker/pern-init
- Owner: atb00ker
- License: mit
- Created: 2021-07-04T10:13:40.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-08-17T19:10:56.000Z (over 3 years ago)
- Last Synced: 2024-11-22T19:10:16.156Z (about 2 months ago)
- Language: TypeScript
- Homepage:
- Size: 34.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# PERN Template
Template for ProgreSQL-Express-React-Node CRUD application. Created for reference for folks who are new to `nodejs`. Hence, some of the steps in this README are verbose. The documentation is written for debian based distributions.
## Pre-requisites
- nodejs
- npm | yarn
- docker
- docker-compose
## Usage
1. Run `npm install` in the root of the repository.
2. Rename `.env.example` to `.env` and update configurations as per requirement.
3. Update `docker-compose.yml` variables.
4. Build application image `docker-compose build`
5. Start application `docker-compose up`
## Creation
1. Install and setup latest version of node & npm using [nvm](https://github.com/nvm-sh/nvm#installing-and-updating)
2. Install backend dependencies:
```bash
npm install --save express sequelize pg pg-hstore cors ws dotenv sequelize-cli
npm install --save-dev node-ts typescript
npm install --save-dev @types/cookie-parser @types/typescript @types/cors @types/ws @types/sequelize @types/dotenv
# Testing
npm install --save-dev jest supertest @types/supertest
npm install --save-dev @babel/plugin-transform-runtime
npm install --save @types/jest
```
3. Install react dependencies:
```bash
npm install --save react react-dom react-router-dom react-use-websocket react-test-renderer
npm install --save typescript @types/node @types/react @types/react-dom @types/jest
npm install --save-dev webpack webpack-cli webpack-dev-server html-webpack-plugin dotenv-webpack
npm install --save-dev @babel/core babel-loader @babel/preset-env @babel/preset-react @babel/preset-typescript
npm install --save-dev css-loader style-loader file-loader
npm install --save axios
# Testing
npm install --save-dev @testing-library/react @testing-library/jest-dom jest react-test-renderer
npm install --save @types/jest
```
4. Initialize and configure database using `npx sequelize-cli init`.
5. Migrate after creating initial migration file `npx sequelize-cli db:migrate`.
## PERN Notes
1. `process.exit()` can be used to exit `repl`.
2. `node-inspector` might be a good resource for the future!
3. Look into: [passportJs](http://www.passportjs.org/) for authentication.
4. Tutorial followed [Youtube @ freeCodeCamp video](https://www.youtube.com/watch?v=G8uL0lFFoN0)