Thien-An-Ngo/sample-project

Sample-Project

A sample to start things of with the database project

Technologies

• express as the main framework
• sqlite3 as database during development
• typescript for typing and comfort
• uuid for secure ids
• bcrypt to encrypt the passwords

optional:

• yarn package manager
• vue.js as frontend framework (frontend-folder; but other frontend frameworks or SSR templating engines might be easier to use)

How to use

Without github cli tools:

• click the fork button
• open terminal
• git clone https://github.com/<yourusername>/sample-project.git
• cd sample-project
• npm install or yarn install
• To start server:
  • npm run start or yarn start
• To start frontend:
  1. cd into frontend
  2. Serve or run
  • npm run serve for hot reload or
• To deploy:
  • frontend:
    1. cd frontend/
    2. Verify options in vue.config.js
    3. npm run build
  • server: npm run build or yarn build

Through terminal:

• install github cli tools if you don't already have them
• open terminal
• gh repo fork https://github.com/Thien-An-Ngo/sample-project.git --clone
• cd sample-project
• npm install or yarn install
• To start server:
  • npm start or yarn start
• To deploy:
  • npm build or yarn build