Welcome to the repository for the website of youth organization Digital Ungdom. The website includes a forum, information about us, and is the central for user registration. The API for this website is found at digitalungdom-api. A development front-end server is set up at dev.digitalungdom.se and the development API is found at devapi.digitalungdom.se.
Below are listed some technologies and packages that are used in the project. Keep in mind that these are only a couple of the many exciting packages that make this application!
- TypeScript
- Internationalization (i18next)
- Redux (@reduxjs/toolkit)
- Formik
- Axios (for customizing API url)
- Storybook
- ESLint + Prettier
- react-router-dom
- Material UI
- React Markdown
- notistack
- Dark mode (through use-dark-mode and Material UI theme)
To start the development website you need to have Node.js installed.
-
Download the project by using
git clone https://github.com/digitalungdom-se/digitalungdom.se.git -
To install our packages and dependencies use
npm install -
Finally, start the project by using
npm run start
Boom, easy, no questions asked. We at Digital Ungdom like it that way!
So you want to contribute? Good, the world needs more brave troopers like you.
If you find a typo, bug or want to add a feature, create an issue or add a pull request with the code you want to add! We will take a look at what you sent in and reward you with gold and glory (or maybe just some stickers) if you help our noble cause.
VSCodium is the recommended integrated development environment, VSCode will work as well. This is due to the fact that several helpful addons that are used in project’s development are only available to VSCodium and VSCode.
To install these extensions please see Visual Studio Code's documentation. If you prefer not to visit sites with proprietary software, do the following steps:
- Open the command palette and choose
Extensions: Install extensions. - Search for your extension.
- Click / select it.
- Press install.
Sidenote: Many required extensions are already built-in in VSCode / VSCodium, such as: TypeScript Language Basics. The necessity for these extensions are not documented.
This repository is GNU AFFERO GENERAL PUBLIC LICENSE.