Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cschindlbeck/solecitos

Website for solecitos
https://github.com/cschindlbeck/solecitos

Last synced: about 20 hours ago
JSON representation

Website for solecitos

Awesome Lists containing this project

README

        

# ☀ Solecitos' Website

Homepage for [Solecitos e.V.](https://cschindlbeck.github.io/solecitos/), a bilingual preschool kindergarten in Hannover, Germany.

Written in React with Material UI, automatically deployed to Github pages.

## Development

Development is done on `devel` branch, with feature branches.

To develop locally, install dependencies via

```bash
npm install
```

Then, run the website on [localhost:3000](http://localhost:3000/) via

```bash
npm start
```

## Docker

```bash
docker build -t solecitos .
```

Then, you can run either

```bash
docker run -p 3000:3000 -v $(pwd):/solecitos solecitos
```

or use docker-compose and run

```bash
docker compose up
```

## Deployment

Production branch is `main` with [SemVer](https://semver.org/).

Deployment is done automatically via Github actions for each push on main with version number in commit message on branch gh-pages

Manually, this can be achieved via

```bash
npm run deploy
```

following [react-gh-pages](https://github.com/gitname/react-gh-pages).

## Precommit Lint

Lint and formatting check are done via pre-commit. The configuration file is .precommit-config.yaml and checks need node version 14 which can be set via

```bash
nvm install 14
```

## License

Copyright Solecitos

Author Chris Schindlbeck