This repository has been archived by the owner on Sep 29, 2024. It is now read-only.
generated from caffeine-addictt/waku
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: AlexNg <[email protected]>
- Loading branch information
1 parent
446c7e6
commit 050c06c
Showing
1 changed file
with
55 additions
and
264 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,308 +1,99 @@ | ||
| <!-- Allow inline html --> | ||
| <!-- markdownlint-disable MD033 --> | ||
| ###### _<div align="right"><sub>// made with <3</sub></div>_ | ||
|
|
||
| <!-- Ignore line length --> | ||
| <!-- markdownlint-disable MD013 --> | ||
|
|
||
| <!-- Disable top-level heading --> | ||
| <!-- markdownlint-disable MD041 --> | ||
|
|
||
| <a name="readme-top"></a> | ||
|
|
||
| <!-- PROJECT LOGO --> | ||
| <br /> | ||
| <div align="center"> | ||
| <a href="https://github.com/caffeine-addictt/greenbitessg"> | ||
| <img src="images/logo.png" alt="Logo" width="80" height="80"> | ||
| </a> | ||
|
|
||
| <h3 align="center">Green Bites SG</h3> | ||
|
|
||
| <p align="center"> | ||
| Sustainable and healthy eating. | ||
| <br /> | ||
| <br /> | ||
| <a href="https://github.com/caffeine-addictt/greenbitessg/issues">Report Bug</a> | ||
| · | ||
| <a href="https://github.com/caffeine-addictt/greenbitessg/issues">Request Feature</a> | ||
| </p> | ||
| </div> | ||
|
|
||
| <!-- TABLE OF CONTENTS --> | ||
| <details> | ||
| <summary>Table of Contents</summary> | ||
| <ol> | ||
| <li> | ||
| <a href="#about-the-project">About The Project</a> | ||
| <ul><li><a href="#built-with">Built with</a></li></ul> | ||
| </li> | ||
| <li> | ||
| <a href="#getting-started">Getting Started</a> | ||
| <ul> | ||
| <li><a href="#prerequisites">Prerequisites</a></li> | ||
| <li><a href="#installation">Installation</a></li> | ||
| </ul> | ||
| </li> | ||
| <li> | ||
| <a href="#documentation">Documentation</a> | ||
| <ul> | ||
| <li><a href="#installing-dependencies">Installing Dependencies</a></li> | ||
| <li><a href="#running-locally">Running locally</a></li> | ||
| <li><a href="#linting">Linting</a></li> | ||
| <li><a href="#testing">Testing</a></li> | ||
| <li><a href="#building">Building</a></li> | ||
| <li><a href="#syncing-shared">Syncing</a></li> | ||
| <li><a href="#running-commands">Running commands</a></li> | ||
| </ul> | ||
| </li> | ||
| <li> | ||
| <a href="#contributing">Contributing</a> | ||
| <ul> | ||
| <li><a href="#commit-message-guidelines">Commit Message Guidelines</a></li> | ||
| <li><a href="#pull-request-guidelines">Pull Request Guidelines</a></li> | ||
| </ul> | ||
| </li> | ||
| <li><a href="#license">License</a></li> | ||
| <li><a href="#contact">Contact</a></li> | ||
| <li><a href="#acknowledgments">Acknowledgments</a></li> | ||
| </ol> | ||
| </details> | ||
|
|
||
| <!-- ABOUT THE PROJECT --> | ||
|
|
||
| ## About The Project | ||
|
|
||
|  | ||
|
|
||
| later | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| ### Built with | ||
|
|
||
| These are the major frameworks and libraries used in this project. | ||
|
|
||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- GETTING STARTED --> | ||
|
|
||
| ## Getting Started | ||
|
|
||
| This is an example of how you can set up your project locally. | ||
| To get a local copy up and running follow these simple example steps. | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - Node v21.6.1 | ||
| - NPM v10.4.0 | ||
|
|
||
| ### Installation | ||
|
|
||
| _Below is an example of how you can install the project locally._ | ||
|
|
||
| #### 1. Clone the Repository | ||
| # GreenBites SG | ||
|
|
||
| ```sh | ||
| git clone https://github.com/caffeine-addictt/greenbitessg | ||
| cd greenbitessg | ||
| ``` | ||
| <!-- Badges --> | ||
|
|
||
| #### 2. Install Dependencies | ||
| [![badge-license]][license] | ||
| ![badge-language] | ||
|
|
||
| ```sh | ||
| npm i # This will install all workspace dependencies as well | ||
| ``` | ||
| <br><br> | ||
|
|
||
| #### 3. Run Development Server | ||
| <!-- Description --> | ||
|
|
||
| ```sh | ||
| npm run dev | ||
| ``` | ||
| Promoting food sustainability and staying healthy. | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
| Fullstack project @ [NYP](https://www.nyp.edu.sg/). | ||
|
|
||
| <!-- DOCS --> | ||
| <br><br> | ||
|
|
||
| ## Documentation | ||
| --- | ||
|
|
||
| You can find the front-end app in the `client/` directory and the back-end API in the `server/` directory. | ||
| API types are shared in the `shared/api-types/` directory and needs to be cloned to client and server with `npm run sync`. | ||
| <!-- TOC --> | ||
|
|
||
| ### Installing dependencies | ||
| **[<kbd> <br> Quick Start <br> </kbd>](#quick-start)** | ||
| **[<kbd> <br> Live Demo <br> </kbd>](https://greenbitessg.ngjx.org)** | ||
| **[<kbd> <br> Thanks <br> </kbd>](#special-thanks)** | ||
|
|
||
| ```sh | ||
| npm i # Install dependencies on all packages | ||
| ``` | ||
| --- | ||
|
|
||
| ### Running locally | ||
| <br> | ||
|
|
||
| ```sh | ||
| npm run dev # Run development server on all packages | ||
| npm run dev:client # Run development server on client | ||
| npm run dev:server # Run development server on server | ||
| ``` | ||
| </div> | ||
|
|
||
| ### Linting | ||
| # Quick Start | ||
|
|
||
| ```sh | ||
| npm run lint # Run ESLint and Prettier on the whole project | ||
| npm run lint:eslint # Run ESLint on all packages | ||
| npm run lint:client # Run ESLint on client | ||
| npm run lint:server # Run ESLint on server | ||
| ``` | ||
| _This is an example of how you can set up your project locally. | ||
| To get a local copy up and running, follow these simple steps._ | ||
|
|
||
| ```sh | ||
| npm run lint:fix # Run ESLint and Prettier on the whole project | ||
| npm run lint:eslint:fix # Run ESLint on all packages and fix any linting errors | ||
| npm run lint:client:fix # Run ESLint on client and fix any linting errors | ||
| npm run lint:server:fix # Run ESLint on server and fix any linting errors | ||
| ``` | ||
| ## Live demo | ||
|
|
||
| ### Testing | ||
| View our live demo [here](https://greenbitessg.ngjx.org). | ||
|
|
||
| ```sh | ||
| npm run test # Run tests on all packages | ||
| npm run test:client # Run tests on client | ||
| npm run test:server # Run tests on server | ||
| ``` | ||
| ## Prerequisites | ||
|
|
||
| ### Building | ||
| - NPM | ||
| - Node.Js | ||
|
|
||
| ```sh | ||
| npm run build # Build all packages | ||
| npm run build:client # Build the client | ||
| npm run build:server # Build the server | ||
| ``` | ||
| ## Running locally | ||
|
|
||
| ### Syncing shared | ||
| _Below is an example of how you can install and run GreenBites_ | ||
|
|
||
| ```sh | ||
| npm run sync # Sync shared dependencies | ||
| npm run sync:check # Check if shared dependencies are synced | ||
| ### 1. Clone the repository | ||
|
|
||
| ```sh | ||
| git clone https://github.com/caffeine-addictt/greenbitessg | ||
| ``` | ||
|
|
||
| ### Running commands | ||
|
|
||
| We use NPM workspaces to share updates to the client and server packages. | ||
| You can use the `-w` flag to run a command in a workspace with the path. | ||
|
|
||
| #### For example | ||
| ### 2. Install dependencies | ||
|
|
||
| ```sh | ||
| npm i tailwindcss -w server # Installs the tailwindcss package in the server workspace | ||
| npm i -D eslint -w shared/api-types # Installs the eslint package in the shared/api-types workspace as a dev dependency | ||
| npm uninstall vite -w client # Uninstalls the vite package in the client workspace | ||
| npm i | ||
| ``` | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- CONTRIBUTING --> | ||
|
|
||
| ## Contributing | ||
|
|
||
| Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. ( ˶ˆᗜˆ˵ ) | ||
|
|
||
| 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! | ||
|
|
||
| 1. Fork the Project | ||
| 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) | ||
| 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) | ||
| 4. Push to the Branch (`git push origin feature/AmazingFeature`) | ||
| 5. Open a Pull Request | ||
|
|
||
| See the [open issues](https://github.com/caffeine-addictt/greenbitessg/issues) for a full list of proposed features (and known issues). | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- COMMIT GUIDELINES --> | ||
|
|
||
| ### Commit Message Guidelines | ||
|
|
||
| When committing, commit messages are prefixed with one of the following depending on the type of change made. | ||
|
|
||
| - `feat:` when a new feature is introduced with the changes. | ||
| - `fix:` when a bug fix has occurred. | ||
| - `chore:` for changes that do not relate to a fix or feature and do not modify _source_ or _tests_. (like updating dependencies) | ||
| - `refactor:` for refactoring code that neither fixes a bug nor adds a feature. | ||
| - `docs:` when changes are made to documentation. | ||
| - `style:` when changes that do not affect the code, but modify formatting. | ||
| - `test:` when changes to tests are made. | ||
| - `perf:` for changes that improve performance. | ||
| - `ci:` for changes that affect CI. | ||
| - `build:` for changes that affect the build system or external dependencies. | ||
| - `revert:` when reverting changes. | ||
|
|
||
| A parenthesis can be placed after the type of change to indicate the scope of the change. Below list some example commit messages. | ||
| ### 3. Run GreenBites | ||
|
|
||
| ```sh | ||
| git commit -m "docs(client): Updated README.md in client/" | ||
| git commit -m "revert(server): Fall back to old typing" | ||
| git commit -m "docs: Moved README.md" | ||
| npm run dev | ||
| ``` | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- PR GUIDELINES --> | ||
|
|
||
| ### Pull Request Guidelines | ||
|
|
||
| When creating a pull request, please use our PR template and follow the checklist provided. | ||
|
|
||
| We require the following CI to pass before the PR can be merged: | ||
|
|
||
| - Linting | ||
| - Tests | ||
| - Client and Server Preview Deployments | ||
|
|
||
| #### Linting locally | ||
|
|
||
| You can lint locally by running `npm run lint` in the root of the project, then run `npm run lint:fix` to automatically fix any linting errors. | ||
|
|
||
| #### Testing locally | ||
|
|
||
| You can test locally by running `npm run test` in the root of the project. | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- LICENSE --> | ||
|
|
||
| ## License | ||
|
|
||
| Distributed under the GNU General Public License version 3.0. See [LICENSE.txt](./LICENSE.txt) for more information. | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
| <div align="right"> | ||
| <br> | ||
| <a href="#-made-with-3"><kbd> <br> 🡅 <br> </kbd></a> | ||
| </div> | ||
|
|
||
| <!-- CONTACT --> | ||
| ## Special Thanks | ||
|
|
||
| ## Contact | ||
| - **[Caffeine-addictt][template-repo]** - _For the repository template_ | ||
| - **[Img Shields][img-shields]** - _For the awesome README badges_ | ||
| - **[Hyprland][hyprland]** - _For showing how to make beautiful READMEs_ | ||
| - **[Hyprdots][hyprdots]** - _For showing how to make beautiful READMEs_ | ||
|
|
||
| Jun Xiang - [[email protected]](mailto:[email protected]) | ||
| <!-- MARKDOWN LINKS & IMAGES --> | ||
| <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
| [license]: https://github.com/caffeine-addictt/greenbitessg/blob/main/LICENSE | ||
|
|
||
| <!-- ACKNOWLEDGMENTS --> | ||
| <!---------------- {{Thanks}} ----------------> | ||
|
|
||
| ## Acknowledgments | ||
| [template-repo]: https://github.com/caffeine-addictt/template | ||
| [hyprland]: https://github.com/hyprwm/Hyprland | ||
| [hyprdots]: https://github.com/prasanthrangan/hyprdots | ||
| [img-shields]: https://shields.io | ||
|
|
||
| - [Repository Template](https://github.com/caffeine-addictt/template) | ||
| - [Choose an Open Source License](https://choosealicense.com) | ||
| - [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet) | ||
| - [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/) | ||
| - [Malven's Grid Cheatsheet](https://grid.malven.co/) | ||
| - [Img Shields](https://shields.io) | ||
| <!---------------- {{Badges}} ----------------> | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
| [badge-language]: https://img.shields.io/github/languages/top/caffeine-addictt/greenbitessg | ||
| [badge-license]: https://img.shields.io/github/license/caffeine-addictt/greenbitessg |