fyindr
/
siimee
关注 4
点赞 3
派生 1
代码 合并请求 1 版本发布 4 百科 动态
您最多选择25个主题 主题必须以字母或数字开头，可以包含连字符 (-)，并且长度不得超过35个字符
91 提交
17 分支
目录树: 5efa3fd0c4
分支列表 标签列表
${ item.name }
创建分支 ${ searchTerm }
从 '5efa3fd0c4'
${ noResults }
siimee/backend
TOJ 5efa3fd0c4 :recycle: added missing files; whoops | using grouping schema to validate incoming membership records 4 年前
..
db :recylce: sorting by score | adding to match_queues table | altering response_key_id 13 to match generated responses 4 年前
lib :recycle: added missing files; whoops | using grouping schema to validate incoming membership records 4 年前
server :sparkles: added ability to send responses and creat new profile 5 年前
tests :gear: adding score test 4 年前
.eslintrc :recycle: just cleaning up config stuff 5 年前
.nycrc :recycle: just cleaning up config stuff 5 年前
.prettierrc :pencil: added formatting and style rules for eslint and prettier 5 年前
README.md :gear: altering response_key schema | :pencil: outlined backend object use 4 年前
knexfile.js :recycle: formatting all the things 5 年前
package-lock.json :sparkles: using sinon to mock objection methods in tests | building mock for Schwifty model registration | working sample test for matchqueue 4 年前
package.json :sparkles: adding generator run command | random email | random user name | insuring 1 user is_poster | generating extra profiles and matching responses for is_poster 4 年前

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 ./server/.env.sample and rename it to ./server/.env
  3. Fill out your database connection details in ./server/.env
  4. A test database container is provided and can be started with docker-compose --env-file ./backend/server/.env up -d
  5. Populate some basic tables for your database using npx knex migrate:latest

: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 seed to seed the database with 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 --env-file ./backend/server/.env up -d
  4. Recreate schemas and tables but navigating to ./backend and running npm run migrate
  5. Reseed the dummy data with npm run seed

: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