-
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.
Bit better readme for the frontend project (#100)
Co-authored-by: ilesoft <[email protected]>
- Loading branch information
Showing
1 changed file
with
40 additions
and
0 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,3 +1,43 @@ | ||
# Tayttopaikka | ||
|
||
Basic React app to provide UI for Tayttopaikka. Running at https://tayttopaikka.fi | ||
|
||
## Tech | ||
|
||
This project uses Vite and React. Bootstrap is used for some general styles, | ||
but we mostly use CSS modules powered with `Sass`. | ||
|
||
## Local development | ||
|
||
Copy example .env file and tweak some variables if needed. **Please notice that every .env variable is public so do not store any real secrets there!** | ||
|
||
``` | ||
cp .env.example .env | ||
``` | ||
|
||
Run the application in local environment | ||
|
||
``` | ||
npm install | ||
npm start | ||
``` | ||
|
||
## Deployment | ||
|
||
When something is pushed to the `main` branch, it is automatically deployed | ||
to production servers. See `fly-deploy.yml` for the deployment pipeline | ||
and `fly.toml` for the container configuration. | ||
|
||
The application is deployed as a container, which has been defined in | ||
`Dockerfile` | ||
|
||
### What really happens | ||
|
||
When the container is being built, it runs `npm run build` and creates an application | ||
bundle which is optimized for production use. The bundle is then copied for | ||
`Nginx` that serves the application to the user. | ||
|
||
## Contributing | ||
|
||
Fork the application and do your thing. Make sure that you run the `enforce-style` script and fix possible errors before opening a PR. Contact @Akzuu or @ilesoft | ||
if you need assistance. |