Skip to content

NoroffFEU/musikkforandrerliv.no

Repository files navigation

musikkforandrerliv.no

img_3078

Description:

Noroff Frontend Developer students are building a web application for the non profit organization Musikk Forandrer Liv (MMF).

This project aim to build a web application:

  • with multipple language support (English, Norwegian and Malagasy)
  • that allows people to support MMF via donations
  • that allows the client, MMF, to update and post content on their page via CMS
  • that allows people visiting the page to sign up for newsletter

Design

Docs

Built with:

  • React
  • Tailwind
  • Decap CMS

Requirements

  • Node version >=18.19.1
  • NPM verion >=10.2.4

Getting started:

Installation:

  1. Ensure you have at least node version 18.19.1 and above and npm version 10.2.4 and above
  2. Run git clone https://github.com/NoroffFEU/musikkforandrerliv.no
  3. Run npm install
  4. Run npm run build
  5. Run npm run dev

Code Quality:

Formatting

The project uses Prettier for code formatting with automatic import sorting. To format your code:

  • Format all files: npm run format
  • Format a specific file: npx prettier --write path/to/file

Linting

ESLint is configured to ensure code quality. To lint your code:

  • Lint all files: npm run lint
  • Lint and fix automatically: npm run lint:fix
  • Lint a specific file: npx eslint path/to/file

Acknowledgments:

2022-2023 Noroff fulltime Frontend development students 2023-2024 Noroff fulltime Frontend development students

Tailwind:

Tailwind is already configured for this project.

Tailwind guide

  • Use Tailwind CSS utility classes in your HTML to style your components

  • If you are writing code and want it to update in the live server, remember to run the following code in terminal: npm run dev

  • If you are not gonna code, but just want to see how the project looks, run this code in the terminal: npm run build

  • plugins you can use to help with tailwind: Tailwind CSS IntelliSense & Tailwind Docs

  • If the Tailwind code is not working, and you have tried the above, you can also look in the Problems tab and see if there are any issues there.