Open-source Charity Platform Podkrepi.bg
What's in the box
- Frontend
- Testing
Perequisites
- Node.js
sudo apt install nodejsn:
sudo npm install -g n
sudo n stable- Yarn > 3.3.0 (Berry)
corepack enable
yarn set version berrycmdtest 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 devVisit
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. 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
Thanks goes to these wonderful people:
If you want to be added or removed from this list please follow up on this issue.
This project fol
... (README truncated for length)