Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 2.96 KB

README.md

File metadata and controls

59 lines (37 loc) · 2.96 KB
Raw

infrarays.se

Welcome to the repository for the application portal website for the organization Rays for excellence, created by Digital Ungdom. The API repository is infrarays-api. A development front-end server is set up at dev--infrarays.netlify.app and the development API is found at devapi.infrarays.digitalungdom.se.

Technologies and packages used

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)
  • styled-components
  • Storybook
  • ESLint + Prettier
  • Bootstrap
  • react-router-dom

Installation 📥

To start the development website you need to have Node.js installed.

  • Download the project by using git clone https://github.com/digitalungdom-se/infrarays.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!

Contribute 🖋️

So you want to contribute? Good, the world needs more scientists like you.

But how? 🤔

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.

Recommended IDE 💾

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.

Recommended extensions for VSCodium

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:

  1. Open the command palette and choose Extensions: Install extensions.
  2. Search for your extension.
  3. Click / select it.
  4. Press install.
Extensions for linting purposes

Sidenote: Many required extensions are already built-in in VSCode / VSCodium, such as: TypeScript Language Basics. The necessity for these extensions are not documented.