Skip to content

Commit

Permalink
Bit better readme for the frontend project (#100)
Browse files Browse the repository at this point in the history
Co-authored-by: ilesoft <[email protected]>
  • Loading branch information
Akzuu and ilesoft authored May 10, 2024
1 parent d72c7cb commit 33d72ca
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions README.md
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.

0 comments on commit 33d72ca

Please sign in to comment.