Skip to content

Commit

Permalink
Add changelog and clean up other docs
Browse files Browse the repository at this point in the history
  • Loading branch information
PurkkaKoodari committed Jan 18, 2024
1 parent 4a0a20a commit ef8045d
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 6 deletions.
47 changes: 47 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Changelog

This document contains the version history of Ilmomasiina.

## 2.0.0

**Visible features**:

- Interface is fully localized in Finnish and English
- Events can be created without a signup, and signups can be created with no event date
- Event descriptions support Markdown
- Name and email questions can be removed
- Users can choose whether their signup name is shown publicly
- Signups can be viewed even after editing closes
- Editable event slugs (instead of numeric IDs) in all user-visible URLs
- Unlisted events (hidden from event list, but can be signed up to)
- Admins can change their password and reset others' passwords
- iCalendar export of event list (can be imported to e.g. Google Calendar)
- Events have a category (can be filtered via API)
- Quotas and questions can be reordered after creating an event
- Admins are warned when changes to an event affect people already signed up
- Installation experience is documented and smoother than previously

**Major technical changes:**

- Entire project ported to TypeScript
- Frontend and backend split to multiple packages
- Backend ported to Fastify
- Frontend built using Vite
- NPM packages created for custom frontends/clients
- Project builds as Docker container automatically
- Dotenv support
- Significantly expanded documentation

**Other changes and fixes:**

- Error messages are actually useful
- "You got a spot from the queue" emails work consistently
- Refreshing/navigating away from a new signup or typoing the email address no longer make the signup unreachable
- Question options can contain semicolons
- Editor performance improved
- More thorough and configurable anonymization of old signups
- Sequential database IDs are no longer visible to users
- Deleted items are not stuck in the database forever
- Signup state (quota/queue and position) is more consistent
- Security vulnerabilities fixed
- Numerous other bug fixes and improvements
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
# Ilmomasiina

Ilmomasiina is the event registration system originally created by Athene, forked by Tietokilta and currently under
heavy development for our new site. Once finished, it will be available for all organizations to use, along with
migration tools from the Athene-made version.
Ilmomasiina is the event registration system originally created by Athene in 2016,
and forked in 2021 by Tietokilta for our new website.
There are [numerous major upgrades](./CHANGELOG.md) from the Athene version.

The latest reviewed development version is in the `dev` branch.
Ilmomasiina is easy to [install](docs/installation.md) in various environments and
is freely available for all organizations to use.
[Migrating](docs/migration.md) from the Athene-made version is also supported.

The latest reviewed development version is in the `dev` branch. You may want to check
current PRs for somewhat stable feature additions.

**Please note that the code is currently in alpha phase and may still have bugs.**
Major features for 2.0 are mostly done and we expect to reach beta in spring 2024.
Major features for 2.0 are mostly done and we expect to reach a stable beta in spring 2024.

## Installation

Expand Down
2 changes: 1 addition & 1 deletion docs/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This file documents the migration process from the Athene-created version of Ilm
## Migration script

The below SQL script migrates the database schema. It is written for MySQL/MariaDB.
Scripts for other databases will be created later.
If you use PostgreSQL, let us know.

There will be more automatic migration tools when we reach production, but the initial migration will likely stay
as a script.
Expand Down

0 comments on commit ef8045d

Please sign in to comment.