-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a8902ff
commit 1afa65d
Showing
2 changed files
with
32 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,33 @@ | ||
|
||
# Development | ||
## Frontend | ||
|
||
|
||
## Backend | ||
### Local backend developing | ||
for developing the backend, use a local go 1.21 development environment. | ||
use the file `internal/cmd/cmd.go` as an entrypoint & make sure that you duplicate (`.env`), adjust and load `.env.template` | ||
* `docker compose up -d db mailhog`: to start the datbase | ||
|
||
### Backend while developing the frontend | ||
for developing only the frontend, a dockerized version of the backend can be used. | ||
in the backend folder: | ||
* `docker compose up --build -d`: to start the datbase & the backend | ||
* `docker compose down`: to stop the datbase & the backend | ||
* `docker compose run --build --rm backend /app/app migrate:resetAndSeed`: reset the database, to apply all migrations and seed | ||
![momentso.png](assets/momentso.png) | ||
|
||
# Momentso | ||
|
||
Welcome to the GitHub repo for Momentso! We're your concise, open-source time tracking alternative to Clockify and Toggl. Momentso, designed by humans on Earth for optimal productivity and efficient time management. Explore, contribute, and optimize your workflow with us. | ||
|
||
## Tech Stack | ||
|
||
**Frontend:** Vue 3, urql, Tailwind CSS | ||
|
||
**Backend:** Go, gqlgen, sqlc, Postgres | ||
|
||
## Development | ||
|
||
### Backend | ||
|
||
For backend development, please utilize a local Go 1.21 development environment. Utilize the file `internal/cmd/cmd.go` as the starting point. Remember to duplicate the `.env` file, amend it according to your needs and load it from `.env.template`. Execute the following command to initialize the database: | ||
|
||
docker compose up -d db mailhog | ||
|
||
### Frontend Development | ||
|
||
When solely focusing on frontend development, utilize a Docker-enabled version of the backend. In the backend directory, execute these commands: | ||
|
||
* `docker compose up --build -d` to initialize the database & the backend. | ||
* `docker compose down` for halting the database and backend services. | ||
* `docker compose run --build --rm backend /app/app migrate:resetAndSeed`, to reset the database, initiating all data migrations and seeding. | ||
|
||
|
||
## License | ||
|
||
[MIT](https://choosealicense.com/licenses/mit/) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.