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.

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

Update README #8

Merged
merged 5 commits into from
Apr 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 1 addition & 3 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
name: Backend Checks

on: [push, pull_request]
on: workflow_dispatch

jobs:
build:
runs-on: ubuntu-latest
environment:
name: Dev

steps:
- uses: actions/checkout@v3
Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ https://github.com/Mwindo/commonplace-public/assets/47676832/3a1b44e7-f2c6-47ef-

## Development

Make a copy of .env_template, fill in the fields, and save as dev.env.
Local environment variables are stored in dev.env.

Modify your [hosts file](https://en.wikipedia.org/wiki/Hosts_(file)) so that dev.commonplace.com routes to 127.0.0.1:

Expand All @@ -28,6 +28,10 @@ and navigate to [dev.commonplace.com](http://dev.commonplace.com).

To log in locally for development, navigate to [dev.commonplace.com/admin](http://dev.commonplace.com/admin) and enter username Admin and password TestPassword.

## Tests

See the ./backend and ./frontend READMEs.

## Deployment

This is a personal project, so deployment details are intentionally left vague. Since it is small, I'm currently spinning it up as a small VM with the Google Compute Engine.
Expand Down
2 changes: 1 addition & 1 deletion backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ The backend is written in Python/Flask and uses a MySQL database (simply because

# Unit Tests

In the application directory (your_local_path/commonplace), run docker exec commonplace-backend-1 python3 -m pytest.
In the application directory (your_local_path/commonplace), run `docker exec commonplace-backend-1 python3 -m pytest` or `docker-compose -f docker-compose-dev.yaml exec backend python3 -m pytest`.
2 changes: 1 addition & 1 deletion frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@

Tests, such as they are, are currently located in the same directory as the components to which they pertain. They need to be expanded.

To run the tests, run: `npm test`
To run the tests, run (from this directory): `npm test`