Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add links to our style guides #689

Merged
merged 3 commits into from
Sep 4, 2020
Merged

Add links to our style guides #689

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
af0a82c
Add links to our style guides
imnasnainaec Sep 4, 2020
e23c2ca
Append missing periods
imnasnainaec Sep 4, 2020
e4d9c46
Merge branch 'master' into style-guides-in-readme
imnasnainaec Sep 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,11 @@ A rapid word collection tool.
- **File** | **Preferences** | **Settings** | Search for **formatOnSave** and
check the box.
7. Run `npm start` from the project directory to install dependencies and start
the project
the project.

8. Consult our [C#](docs/c_sharp_style_guide.md)
and [JavaScript/TypeScript](docs/ts_style_guide.md)
style guides for best coding practices in this project.

[chocolatey]: https://chocolatey.org/

Expand Down Expand Up @@ -92,11 +96,11 @@ Runs only the front end of the app in the development mode.

#### `npm run api`

Runs only the API
Runs only the API.

#### `npm run database`

Runs only the mongo database
Runs only the mongo database.

### `npm test`

Expand Down Expand Up @@ -172,8 +176,8 @@ npm run import-sem-doms -- <XML_FILE_PATH>

To browse the database locally during development, open MongoDB Compass Community.

1. Under New Connection, enter `mongodb://localhost:27017`
2. Under Databases, select CombineDatabase
1. Under New Connection, enter `mongodb://localhost:27017`
2. Under Databases, select CombineDatabase

### Drop Database

Expand Down