This repository has been archived by the owner on Jun 18, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
2 additions
and
86 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,86 +1,2 @@ | ||
| # PesaYetu | ||
|
|
||
| ## Description | ||
|
|
||
| PesaYetu, an easy-to-use visualization tool that helps journalists quickly find, analyse and compare government budget data to help fact-check claims about resource allocations, public procurement and development plans or services. Accessible at [https://pesayetu.pesacheck.org](https://pesayetu.pesacheck.org) | ||
|
|
||
| Built with love ❤️ using [Nextjs](https://github.com/vercel/next.js/), Javascript and a couple other helper libraries (see [package.json](./package.json)). | ||
|
|
||
| This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). | ||
|
|
||
| ## Getting Started | ||
|
|
||
| ### Installation | ||
|
|
||
| From the root folder, run `yarn` to install all dependencies, alternatively you can run `npm install` | ||
|
|
||
| ```bash | ||
| $ yarn | ||
| ``` | ||
|
|
||
| ### Running the app | ||
|
|
||
| ```bash | ||
| # watch mode | ||
| $ yarn dev | ||
|
|
||
| # building | ||
| $ yarn build | ||
|
|
||
| # running compiled | ||
| $ yarn start | ||
| ``` | ||
|
|
||
| ### Useful Scripts | ||
|
|
||
| In the project directory, you can run: | ||
|
|
||
| #### `yarn start` or `yarn dev` (for watch mode) | ||
|
|
||
| Runs the app in the development mode. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. | ||
|
|
||
| [API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api](http://localhost:3000/api/). This endpoint can be edited in `pages/api`. | ||
|
|
||
| The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. | ||
|
|
||
| #### `yarn lint` | ||
|
|
||
| Executes lint and tries to fix all fixable lint errors | ||
|
|
||
| #### `yarn build` | ||
|
|
||
| Builds the app for production to the `dist` folder.\ | ||
| It correctly bundles Server in production mode and optimizes the build for the best performance. | ||
|
|
||
| See the next [build](https://nextjs.org/docs/api-reference/cli#build) documentation for more details. | ||
|
|
||
| #### `yarn storybook` | ||
|
|
||
| Starts a sandbox to view all resusable components developed in the aplication. Open [http://localhost:6006](http://localhost:6006) with your browser to see the result. | ||
|
|
||
| ### Project Structure | ||
|
|
||
| ``` | ||
| . | ||
| ├── Dockerfile | ||
| ├── LICENCE | ||
| ├── README.md | ||
| ├── jsconfig.json | ||
| ├── next-seo.config.js | ||
| ├── next.config.js | ||
| ├── package.json | ||
| ├── public | ||
| │ ├── favicon.ico | ||
| │ ├── fonts | ||
| │ └── styles | ||
| ├── src | ||
| │ ├── assets | ||
| │ ├── components | ||
| │ ├── config.js | ||
| │ ├── functions | ||
| │ ├── lib | ||
| │ ├── pages | ||
| │ ├── theme | ||
| │ └── utils | ||
| └── yarn.lock | ||
| ``` | ||
| # NOTE | ||
| Moved to [Commons UI](https://github.com/CodeForAfrica/ui/tree/main/apps/pesayetu) monorepo. |