Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump lodash from 4.17.15 to 4.17.21 #34

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 91 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,91 @@
# ksicht
KSICHT website
# What is this?

This is the KSICHT [chemistry competition website](https://ksicht.natur.cuni.cz/)
that allows elementary and high schools students to show off theirs skills on
a series of challenging tasks.

The competition takes place annually and consist of 4 quaterly series that
loosely follow the general school year, e.g. starts on autumn and finishes at
late spring. Each series has approx. 5 tasks to complete and contenders
will receive points for each task separately. The contestant to receive the most
points in total wins. They can also receive bonus badges for various
acheievements.

## Tech details

This app is built with Python powered by [Django](https://www.djangoproject.com/)
with the usual bells and whitles. Styling is based on
the [Bulma CSS framework](https://bulma.io/). We use PostgreSQL as the database.

## Development

Please make sure you have [NVM](https://github.com/nvm-sh/nvm) installed first.

### Installing

Activate NVM:

```bash
nvm use
```

There is a `Makefile` to simplify tasks. Start by creating your Python virtual
env:

```bash
make init-env && source .env/bin/activate
```

Next, install dependencies including the dev and test stuff:

```bash

make install && make install-dev && make install-test
```

You will also need to boostrap your database. By default, a PostgreSQL database named
`ksicht` is expected to exist on your local machine. This can be modified by
overriding the `DATABASE_DSN` env variable when running the app.

First though, you'll need the database to exist:

```bash
createdb ksicht
```

Once there, initialize the database by issuing:

```bash
make migrate
```

This will run Django migrations & will create all the necessary tables.

### Running the app

Just run this:

```bash
make run
```

### Running tests

Again, use the `Makefile`:

```bash
make test
```

### Building & deploying

This app is distributed as a Docker container
and [hosted on Docker Hub](https://hub.docker.com/r/xaralis/ksicht).
Makefile provides all the necessary commands:

```bash
make build && make push

# Shortcut to the above:
make release
```
6 changes: 3 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
black
pylint
isort
django-debug-toolbar
django-debug-toolbar<3.3.0