simponic/LocChat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Joseph Ditton 2021-12-03 18:48:52 -07:00
parent c14d0a89a2
commit bbed498bca
3 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -20,7 +20,12 @@ Finally, run
```bash ```bash
$ bash ./bin/setup_new_project.sh $ bash ./bin/setup_new_project.sh
``` ```
and follow the prompts. This script will link the repo to your new repo while maintaining a reference to the starter app. This way, if we make changes to the starter app, you can still get those changes. and follow the prompts. This script will link the repo to your new repo while maintaining a reference to the starter app repo. This way, if we make changes to the starter app repo, you can still get those changes.
To retrieve changes from the starter app run
```bash
$ git pull upstream main
```
## Prerequisites ## Prerequisites
### asdf-vm ### asdf-vm
Tool versions are managed using `asdf-vm`. You will need to have `asdf-vm` installed first. Tool versions are managed using `asdf-vm`. You will need to have `asdf-vm` installed first.
@ -57,11 +62,11 @@ $ cd client && yarn && cd ..
``` ```
### Database ### Database
To setup the database run This application uses Postgres. To setup the database run
```bash ```bash
$ yarn db:setup $ yarn db:setup
``` ```
This will create the database, run the migrations, and run the seed for you. This will create the database, run the migrations, and run the seeds for you.
### Migrations ### Migrations
Any time you want make changes to your database schema you will need to generate a migration file Any time you want make changes to your database schema you will need to generate a migration file
@ -77,7 +82,7 @@ will run any pending migrations.
If a team member adds a migrations you will need to run the migrate command to make the changes to your local database as well. If a team member adds a migrations you will need to run the migrate command to make the changes to your local database as well.
### Seeds ### Seeds
Seeds allow you prepopulate your database with data. By default this application prepopulates the `Roles` and the Admin `User` into your database. Seeds allow you to pre-populate your database with data. By default this application prepopulates the `Roles` and the Admin `User` into your database.
If you make changes to the seeds file at `server/database/seeds.ts` the make sure that, in the event seeds are run multiple times, you don't end up with duplicate data. If you make changes to the seeds file at `server/database/seeds.ts` the make sure that, in the event seeds are run multiple times, you don't end up with duplicate data.

1
bin/setup_new_project.sh
View File

@ -1,6 +1,5 @@
#!/bin/bash #!/bin/bash
source .env
echo "What is the name of your application?" echo "What is the name of your application?"
read appname read appname

1
package.json
View File

@ -6,6 +6,7 @@
"private": true, "private": true,
"license": "UNLICENSED", "license": "UNLICENSED",
"scripts": { "scripts": {
"pullstarterapp": "git pull upstream main",
"typeorm": "ts-node -r tsconfig-paths/register ./node_modules/typeorm/cli.js --config server/database/cli_config.ts", "typeorm": "ts-node -r tsconfig-paths/register ./node_modules/typeorm/cli.js --config server/database/cli_config.ts",
"db:start": "pg_ctl status || pg_ctl start", "db:start": "pg_ctl status || pg_ctl start",
"db:stop": "pg_ctl status && pg_ctl stop", "db:stop": "pg_ctl status && pg_ctl stop",