fyindr
/
siimee
關注 4
收藏 3
複製 1
程式碼 合併請求 1 版本發佈 4 Wiki 活動
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
643 提交
17 分支
目錄樹: 8cfb368ea3
分支列表 標籤
${ item.name }
建立分支 ${ searchTerm }
從 '8cfb368ea3'
${ noResults }
siimee/backend
j 9888a03592 :gear: resolving package-lock with audit 2 年之前
..
db another pre-release (#53) 2 年之前
lib :recycle: little post rebase fix 2 年之前
server :gear: fixing knex config ssl bug 3 年之前
tests :recycle: fixing up tag schema | fixing up pairing 3 年之前
.env.sample :pencil2: Replaced session salt string in .env.sample 2 年之前
.eslintrc eslint switch case update to match prettier 3 年之前
.nycrc :recycle: just cleaning up config stuff 5 年之前
.prettierrc :gear: redoing prettier config | running prettier | adding some sample wave-ui elements 3 年之前
README.md :recycle: a bunch of random changes before we get started 3 年之前
docker-compose.yml :recycle: integrating chat view into pairs and reworking pubnub 3 年之前
knexfile.js :gear: making the knew config similar to the backend server config 3 年之前
package-lock.json :gear: resolving package-lock with audit 2 年之前
package.json :construction: Set up scaffolding for other jwt lib 2 年之前

README.md

siimee backend API

An API for the siimee application

:white_check_mark: Prerequisites

You will need…

Node.js 14+

:package: Installation

  1. Install dependencies with npm install
  2. Copy the environments sample file from ./backend/.env.sample and rename it to ./backend/.env
  3. Fill out your database connection details in ./backend/.env
  4. A test database container is provided and can be started with docker-compose up -d
  5. Populate some basic tables for your database using npm run generate && npm run reseed

:package: Migrations

We use Knex.js,which comes with a couple nice database migration and seeding tools. Migrating tracks changes in schema. Migration steps are contained in the ./db/migrations folder. Seeding adds dummy data once our database tables have been created and schemas are set. Starting seed steps are contained in ./db/seeds and use the mock.js file as the main dummy data source.

Migrating

  • Run npm run migrate to run all migrations and establish the base schema
  • Run npm run unmigrate to roll back one migration

Seeding

  • Run npm run generate to generate dummy data
  • Run npm run seed to seed the database with generated dummy data

Restarting

Since we can’t unseed the database, it’s best to destroy the dev database and rebuild it.

  1. Stop the database by navigating to the project root directory cd ../ and running docker-compose down
  2. Destroy the database volume docker volume rm siimee_siimee_db. BE CAREFUL.
  3. Restart the database while still at the project root with docker-compose up -d
  4. Recreate schemas,tables and dummy data by navigating to ./backend and running npm run reseed

:electric_plug: Run

  1. Run npm run start to start up the server
  2. Check http://localhost:3001/documentation to see the interactive API documentation

:robot: Deployment

TBD

:pill: Tests & Code Quality

Tests are run with AVA with code coverage reporting via nyc. Look at the example test for ideas, as well as the ava documentation

  • Run tests with coverage report with npm test

:heart: Built With