Skip to content

Commit c6cf2dd

Browse files
committed
docs: add project goal
1 parent c7c0c25 commit c6cf2dd

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Citizens are watching
77
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
88
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
99

10+
- [⭐ Goal](#-goal)
1011
- [🌎 Environments](#-environments)
1112
- [🍱 Tech Stack](#-tech-stack)
1213
- [Front-end](#front-end)
@@ -28,13 +29,19 @@ Citizens are watching
2829

2930
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
3031

32+
## ⭐ Goal
33+
34+
We want to record and visualise the Thai parliament information including politicians, assemblies, bills, voting processes, and promises.
35+
36+
This project can be seen as a renovated combination of [They Work for Us](https://github.com/wevisdemo/they-work-for-us), [Law Watch](https://github.com/wevisdemo/law-watch), and [Promise Tracker](https://github.com/wevisdemo/promise-tracker) which aim to support several election era.
37+
3138
## 🌎 Environments
3239

33-
| Name | URL |
34-
| ---------------------- | ---------------------------------- |
35-
| Branch Preview | Provided by Cloudflare Pages |
36-
| Staging (main branche) | https://parliament-watch.pages.dev |
37-
| Production | - |
40+
| Name | URL |
41+
| --------------------- | ---------------------------------- |
42+
| Branch Preview | Provided by Cloudflare Pages |
43+
| Staging (main branch) | https://parliament-watch.pages.dev |
44+
| Production | - |
3845

3946
## 🍱 Tech Stack
4047

@@ -53,7 +60,7 @@ Citizens are watching
5360
- Validate that commit message is align with [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) using commitlint
5461
- Run svelte-check before pushing
5562
- For VSCode user, format on save is enabled and [prettier-vscode extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) will be recommended when open the project.
56-
- [Hygen](http://www.hygen.io) for code generation
63+
- [Hygen](http://www.hygen.io) for a code generation
5764

5865
### Deployment pipeline
5966

0 commit comments

Comments
 (0)