README.md

Open-source Charity Platform Podkrepi.bg

What's in the box

• Frontend
  • Typescript
  • Next.js
  • MaterialUI
  • Formik / MobX
  • ESlint / Prettier / Husky / Stylelint / Lint Staged
  • Sentry
• Testing
  • Playwright

Perequisites

• Node.js
  • Installation
    • Windows / MacOS
    • Debian and Ubuntu based Linux distributions

    sudo apt install nodejs

  • If you have newer Node version, you can downgrade it with n:

  sudo npm install -g n
  sudo n stable

• Yarn > 3.3.0 (Berry)
  • Installation https://yarnpkg.com/getting-started/install

  corepack enable
  yarn set version berry

  • make sure cmdtest is not installed, it has a different yarn command

Initial setup

git clone [email protected]:podkrepi-bg/frontend.git
cd frontend

# Symlink dev environment on Mac / Linux
ln -nfs .env.local.example .env.local

# Symlink dev environment on Windows
mklink .env.local .env.local.example

# Install dependencies
yarn

# Start the project
yarn dev

Visit http://localhost:3040/

Starting the backend

In order to use the frontend together with the API for it you need to clone and start the backend project.

Follow API instructions at https://github.com/podkrepi-bg/api#setup-development-environment

Using Stripe and testing payments

In order to use the frontend together with the API and be able to test donations and payments you would need to install and start a StripeCLI

Follow the instructions at https://github.com/podkrepi-bg/api/blob/master/TESTING.md

Testing

End to end testing is done on every PR with Playwright. Github Workflows start the whole stack and run tests in headless mode.

Read more at End-2-End Testing

Stay up-to-date with latest progress

Watch releases of this repository to be notified about future updates:

Contributors ✨

Please check contributors guide for:

• Development setup
• Linting
• Production setup
• Pull requests guidelines
• Branching strategy
• React guidelines
  • Imports
  • File structure
  • Types
  • Components definition
  • Styles
  • Translations

Thanks goes to these wonderful people:

Ilko 💻 📖 👀 🚧 🐛 💡	StanislavSt 💻 📖 👀 🔧	Sotir 💻 📖 👀 🔧	Ani 💻 📖	Nikola Andreev 💻 📖 🔧	Pete Pavlovski 💻 📖 👀	Georgi Uzuntonev 💻 📖 👀 🔧	Viktor Todorov 💻 📖 👀 🔧	Martin Kovachev 💻 📖 🔧 🚇 🚧 🛡️	igoychev 💻 📖 🔧 🚇 🚧 🛡️
VPeykovski 💻	Dimitar Nizamov 💻 📖 🔧	Andrey Marchev 💻 📖 🔧 📦 👀	dianakarcheva 💻 📖 🔧 📦 👀	Mayya Peneva 💻 📖 🔧 📦 👀	RRoussev88 💻 📖	Martin Marchev 💻 📖	Atanas Alexandrov 💻 📖 ⚠️ 🐛 🔧	Tanyo Georgiev 💻 📖 🔧 📦	Stanimir Dimitrov 💻 📖 🔧 📦 ⚠️ 👀
Ivan Milchev 💻 📖 🔧 📦 ⚠️ 👀	tvalchev 💻 📖 🔧	Vladislav Mihov 💻 📖 🔧 📦	Gottfrid Svartholm 💻 📖 🔧	Preslav Gerchev 💻 📖 🔧 📦 ⚠️ 👀	George Naumov 💻 📖 🔧	Atanas Stoyanov 💻 📖 🔧 📦 🚧	Vanyo 💻 📖 🔧	Kiril Popov 💻 📖 🔧 📦 🔌	dragomir-yankov 💻 📖 🔧 📦
Ikko Ashimine 💻 📖	hstoyanov 💻 📖 🔧	Lyuboslav Tihomirov Lyubenov 💻 📖 🔧 📦	Bunny303 💻 📖 🔧	Dimitar Plamenov Dimitrov 💻 📖 🔧	Simeon Shopov 💻 📖 🔧	Angelina 💻 📖 🔧	Kalin Konstantinov 💻 📖 🔧	Marina-yoya 💻 📖 🔧	Borislav Stoychev 💻 📖 🔧
Dimitar Markov 💻 📖 🔧	Todor Belchev 💻 📖 🔧	Pepi Petrov 💻 📖 🔧	Stilian Nikolaev 💻 📖 🔧	Neli Radkova 💻 📖 🔧	Kalin Harmandzhiev 💻 📖 🔧	Petar Dzhunov 💻 📖 🔧	Ivan Kraev 💻 📖 🔧	Yakimov1337 💻 📖 🔧	Georgy Genchev 💻 📖 🔧
Zlatko 💻	Margarita 💻	Lachezar Marinov 💻	Boyan Vushkov 💻	Valentin Kirilov 💻 📖	Kishor Kc 💻	stann1 💻 📖 🔧 🛡️ 📆	Anzhelo Dimitrov 💻	Andrey Goranov 💻	Anton Mihaylov 💻
kabaivanov 💻	Lyoubomir Katzarov 💻	Nikolay Nachev 💻	Slavcho Ivanov 💻 👀 ⚠️	Aleksandar Petkov 💻 👀	Bogomil Tsvetkov 💻 ⚠️	Dzhani Ivanov 💻	mm-hstefanova 💻	yg1y 💻 ⚠️	Anton Angelov 💻
yyosifov 💻	Dimitar Filipov 💻	Alexander 💻	RalitsaIlieva 💻	Kalina Zhecheva 💻 ⚠️	Petar Dimitrov 💻	Krum Dachev 💻	Tuscann ⚠️	iliyan90 💻	Georgi Parlakov 💻
Teodora Zhelyazkova 💻	Martin Kovachki 💻 ⚠️	Viktor Stefanov 💻	velnachev 💻	Nikolay Yankov 💻	Katina Anachkova 💻

If you want to be added or removed from this list please follow up on this issue.

This project follows the all-contributors specification. Contributions of any kind are welcome!