Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tomhaerter committed Sep 26, 2023
1 parent a8902ff commit 1afa65d
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 16 deletions.
48 changes: 32 additions & 16 deletions README.md
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/)
Binary file added assets/momentso.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1afa65d

Please sign in to comment.