Skip to content

Commit

Permalink
Ready for OSS (#1)
Browse files Browse the repository at this point in the history
* make copy to clipboard reusable

* clean up papaparse usage

* run formatter and rename vars

* format code on save

* update README.md
  • Loading branch information
mudssrali committed Sep 12, 2022
1 parent b4233cc commit 179389e
Show file tree
Hide file tree
Showing 16 changed files with 159 additions and 3,745 deletions.
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"editor.formatOnSave": true
}
29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# BeSafePakistan
# Be Safe Pakistan

A crowdsourcing platform to provide latest updates, database of welfare organizations, local fundraisers and volunteers for ongoing flood relief efforts across Pakistan.
A crowdsourcing platform to provide latest 2022 floods updates, database of local and international welfare organizations, local fundraisers and volunteers for ongoing flood relief efforts across Pakistan.

## Getting started

Expand All @@ -16,4 +16,27 @@ Next, run the development server:
npm run dev
```

Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website.
## Deployment

This is static website, built with `next.js` and styled with `tailwindcss 3.0`. It's deployed on `Netlify` with automated deployment enabled on `main` branch with custom domain.


Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website.
## Roadmap

This is initial version of [BeSafePakistan](https://besafepakistan.com) however we need to add or change following items:

- [ ] Show interactive, static imagery and video flood-battered areas with captions
- [ ] Show flood devastation stats in form interactive graphs, charts etc (data gathering in process)
- [ ] Show all news links with on-scroll animation
- [ ] Improve rendering `fundraisers` data (formatting and cleaning up the data - WIP)
- [ ] Add functionality to export fundraisers data as CSV
- [ ] Add functionality to copy welfare organization bank account details (only for local), See *`Fundraisers.jsx`* already implemented something like this
- [ ] Update news links daily
- [ ] Update flood devastation stats daily

If you're interested in working on these items, happy to talk :)

## Contributions

Contributions of all kind are welcome. Fork this repo, clone, create branch and make the first commit for change. Finally open a PR with appropriate title (each word, first letter must be upper-case)
Loading

0 comments on commit 179389e

Please sign in to comment.