Project name

Insert bullets description of the project if available.

Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project.

Contributing

This project is built by amazing volunteers and you can be one of them! Here's a list of ways in which you can contribute to this project. If you want to make any change to this repository, please make a fork first.

Help us out by testing this project in the staging environment. If you see something that doesn't quite work the way you expect it to, open an Issue. Make sure to describe what you expect to happen and what is actually happening in detail.

If you would like to suggest new functionality, open an Issue and mark it as a [Feature request]. Please be specific about why you think this functionality will be of use. If you can, please include some visual description of what you would like the UI to look like, if you are suggesting new UI elements.

Built With

This project is built with Next.js and TypeScript.

Local Development

Note for Windows users: If you are using Windows, please use WSL to follow the instructions below. The instructions below consider that you are on a *nix type environment.

Clone the repo

To get started , you will first have to clone the repo.

git clone https://github.com/code4romania/war-support-sprijin-de-urgenta-client
cd war-support-sprijin-de-urgenta-client

Install dependencies

You can use any node package manager you prefer to install the dependencies (npm, yarn, pnpm, etc.)

If you use npm please paste the command below in your terminal:

npm install

If you use yarn please paste the command below in your terminal:

yarn install

If you use pnpm please paste the command below in your terminal:

pnpm install

Build the Project

If you use npm please paste the command below in your terminal:

npm run build

If you use yarn please paste the command below in your terminal:

yarn build

If you use pnpm please paste the command below in your terminal:

pnpm run build

Utility Scripts

i18n (Internationalization)

To generate the translation files you will need to run the following command:

npm run generate-translations-sheet
npm run translate

Visualize frontend components

We use storybook to visualize the components.

npm run storybook

Testing

To run the E2E tests you will need to run the following command:

npm run e2e

Feedback

Request a new feature on GitHub.
Vote for popular feature requests.
File a bug in GitHub Issues.
Email us with other feedback contact@code4.ro

License

This project is licensed under the MPL 2.0 License - see the LICENSE file for details

About Code for Romania

Started in 2016, Code for Romania is a civic tech NGO, official member of the Code for All network. We have a community of around 2.000 volunteers (developers, ux/ui, communications, data scientists, graphic designers, devops, it security and more) who work pro-bono for developing digital solutions to solve social problems. #techforsocialgood. If you want to learn more details about our projects visit our site or if you want to talk to one of our staff members, please e-mail us at contact@code4.ro.

Last, but not least, we rely on donations to ensure the infrastructure, logistics and management of our community that is widely spread across 11 timezones, coding for social change to make Romania and the world a better place. If you want to support us, you can do it here.