![Logo](/stanleyclaudius/donation-app/raw/main/client/public/image/logo.png)
An awesome donation application based on website
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
Donation App is a web application that the main functionality is to allow their user to create a campaign and donate to it. This website have 3 roles inside it, such as admin, fundraiser, and general user. Each roles can access to different resources that support the main lifecycle of this application.
Main technology used to built this application are listed below:
To get started with this project locally, follow below steps:
Make sure you have go, docker, and package manager (either npm or yarn) installed
FYI: This project uses yarn as the client package manager, but you're free to use npm too.
Below steps will guide you through the local installation process of this application
- Clone the repo
git clone https://github.com/stanleyclaudius/donation-app.git
- Install client-side dependency
Make sure that your terminal pointing at the root directory of this project (donation-app folder).cd client && yarn install
- Spin up Docker, then open up the terminal, and change directory to the server folder, then run below command
make postgres && make createdb && make migrateup
- Note that, the admin account should be created manually in the database
- Complete the .env variable
Rename .env.example file at/config
directory become.env
, then fill the value for every key. Below is the guideline for filling the .env value:
Key What To Fill Example Value DB_DRIVER Your database driver postgres DB_SOURCE Your database source URL postgresql://root:xxx SERVER_ADDRESS Your server address 0.0.0.0:8080 TOKEN_SYMMETRIC_KEY Random 32 characters length string 7888329xxx ACCESS_TOKEN_DURATION Access token duration 15m REFRESH_TOKEN_DURATION Refresh token duration 24h - Lastly, open 2 terminal at the same time, and run below command at your terminal to spin off the application
cd client && yarn start
cd server && make server
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt
for more information.
LinkedIn: Stanley Claudius
Project Link: https://github.com/stanleyclaudius/donation-app
Special thanks to:
- Othneildrew for providing an amazing README template.
- Tailwind CSS for providing CSS framework to be used in this application.
- React Icons for providing icon to be used in this application.