https://github.com/podkrepi-bg/frontend

Charity platform https://podkrepi.bg Docs https://docs.podkrepi.bg
https://github.com/podkrepi-bg/frontend

charity charity-platform frontend hacktoberfest hacktoberfest2022 nextjs react scss typescript

Last synced: 29 days ago
JSON representation

Charity platform https://podkrepi.bg Docs https://docs.podkrepi.bg

• Host: GitHub
• URL: https://github.com/podkrepi-bg/frontend
• Owner: podkrepi-bg
• License: mit
• Created: 2020-12-16T08:21:38.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T17:10:50.000Z (about 2 months ago)
• Last Synced: 2024-10-29T18:39:30.087Z (about 2 months ago)
• Topics: charity, charity-platform, frontend, hacktoberfest, hacktoberfest2022, nextjs, react, scss, typescript
• Language: TypeScript
• Homepage: https://podkrepi.bg
• Size: 90.4 MB
• Stars: 174
• Watchers: 39
• Forks: 86
• Open Issues: 92
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        




  Open-source Charity Platform Podkrepi.bg





  





  






  




## What's in the box

- Frontend

  - [Typescript](https://www.typescriptlang.org/)

  - [Next.js](https://nextjs.org/)

  - [MaterialUI](https://material-ui.com/)

  - [Formik](https://formik.org/) / [MobX](https://mobx.js.org/)

  - [ESlint](https://eslint.org/) / [Prettier](https://prettier.io/) / [Husky](https://github.com/typicode/husky) / [Stylelint](https://stylelint.io/) / [Lint Staged](https://github.com/okonet/lint-staged)

  - [Sentry](https://sentry.io/organizations/podkrepibg/)

- Testing

  - [Playwright](https://playwright.dev/)

## Perequisites

- Node.js

  - Installation

    - [Windows / MacOS](https://nodejs.org/en/download/)

    - [Debian and Ubuntu based Linux distributions](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)

    ```shell

    sudo apt install nodejs

    ```

  - If you have newer Node version, you can downgrade it with [`n`](https://www.npmjs.com/package/n):

  ```shell

  sudo npm install -g n

  sudo n stable

  ```

- Yarn > 3.3.0 (Berry)

  - Installation https://yarnpkg.com/getting-started/install

  ```shell

  corepack enable

  yarn set version berry

  ```

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

## Initial setup

```shell

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 

## 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 

## 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 

## Testing

End to end testing is done on every PR with [Playwright](https://playwright.dev/). Github Workflows start the whole stack and run tests in headless mode.

Read more at [End-2-End Testing](https://github.com/podkrepi-bg/frontend/blob/master/e2e/README.md)

## Stay up-to-date with latest progress

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

![Peek 2022-12-23 11-19](https://user-images.githubusercontent.com/893608/209308853-ddb8dfe8-1c42-4c18-be9c-4d55f8599d73.gif)

## Contributors ✨

[![All Contributors](https://img.shields.io/badge/all_contributors-86-orange.svg?style=flat-square)](#contributors-)

Please check [contributors guide](https://github.com/podkrepi-bg/frontend/blob/master/CONTRIBUTING.md) for:

- [Development setup](https://github.com/podkrepi-bg/frontend/blob/master/CONTRIBUTING.md#development)

- [Linting](https://github.com/podkrepi-bg/frontend/blob/master/CONTRIBUTING.md#linting)

- [Production setup](https://github.com/podkrepi-bg/frontend/blob/master/CONTRIBUTING.md#production)

- [Pull requests guidelines](https://github.com/podkrepi-bg/frontend/blob/master/CONTRIBUTING.md#pull-requests)

- [Branching strategy](https://github.com/podkrepi-bg/frontend/blob/master/CONTRIBUTING.md#branching-strategy)

- [React guidelines](https://github.com/podkrepi-bg/frontend/blob/master/CONTRIBUTING.md#react-guidelines)

  - [Imports](https://github.com/podkrepi-bg/frontend/blob/master/CONTRIBUTING.md#imports)

  - [File structure](https://github.com/podkrepi-bg/frontend/blob/master/CONTRIBUTING.md#file-structure)

  - [Types](https://github.com/podkrepi-bg/frontend/blob/master/CONTRIBUTING.md#types)

  - [Components definition](https://github.com/podkrepi-bg/frontend/blob/master/CONTRIBUTING.md#components)

  - [Styles](https://github.com/podkrepi-bg/frontend/blob/master/CONTRIBUTING.md#styles)

  - [Translations](https://github.com/podkrepi-bg/frontend/blob/master/CONTRIBUTING.md#translations-i18n)

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](https://github.com/podkrepi-bg/frontend/issues/2).

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome!