-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #361 from picsoritdidnthappen/database-migration
Database migration
- Loading branch information
Showing
4 changed files
with
258 additions
and
126 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,28 +1,133 @@ | ||
## Refactor Notes: | ||
## Contributing | ||
|
||
Steps: | ||
Thank you for your interest in contributing to POIDH! Before you start coding, please review this guide to ensure a smooth process from development to submitting a pull request. | ||
|
||
- Make sure everything is typed in a clean way | ||
- Fix linting and formatting errors | ||
- Fix hydration errors | ||
- Remove redundant code / Unused files | ||
- Rename everything with Proofs -> Claims | ||
- Make sure everything that can/should be rendered server side is (ie rpc requests, etc) | ||
If you're new or unsure where to begin, check the [Discussions](https://github.com/poidh/poidh-app/discussions) tab for ideas and help. | ||
|
||
Bugs Encountered: | ||
### Quick Start Guide | ||
|
||
Changes Made: | ||
This guide will help you set up your local environment for running and contributing to the POIDH app, including setting up automatic formatting and linting. | ||
|
||
# POIDH App | ||
#### Overview | ||
|
||
## Overview | ||
- [Cloning the Repository](#cloning-the-repository) | ||
- [Installing Node.js and pnpm](#installing-nodejs-and-pnpm) | ||
- [Installing Dependencies](#installing-dependencies) | ||
- [Running the Project](#running-the-project) | ||
- [Submitting Pull Requests](#submitting-pull-requests) | ||
|
||
POIDH App | ||
--- | ||
|
||
## Installation | ||
### Cloning the Repository | ||
|
||
To install the dependencies, run the following command: | ||
1. Clone the repository to your local machine. Ensure you have Git installed. [Git installation guide](https://git-scm.com/docs). | ||
|
||
```sh | ||
npm install | ||
``` | ||
```bash | ||
git clone https://github.com/poidh/poidh-app.git | ||
``` | ||
|
||
Or, if you have the [GitHub CLI](https://cli.github.com) installed: | ||
|
||
```bash | ||
gh repo clone picsoritdidnthappen/poidh-app | ||
``` | ||
|
||
2. Navigate into the project directory. | ||
|
||
```bash | ||
cd poidh-app | ||
``` | ||
|
||
<div align="right"> | ||
<a href="#quick-start-guide">↑ Back to Overview</a> | ||
</div> | ||
|
||
--- | ||
|
||
### Installing Node.js and pnpm | ||
|
||
POIDH uses **pnpm** as a package manager and requires **Node.js v18.12 or higher**. | ||
|
||
1. Check your versions to confirm compatibility: | ||
|
||
```bash | ||
node -v | ||
pnpm -v | ||
``` | ||
|
||
2. If you need to install or update: | ||
|
||
- [Install Node.js](https://nodejs.org) | ||
- [Install pnpm](https://pnpm.io/) | ||
|
||
<div align="right"> | ||
<a href="#quick-start-guide">↑ Back to Overview</a> | ||
</div> | ||
|
||
--- | ||
|
||
### Installing Dependencies | ||
|
||
1. In the project root directory, install all required dependencies: | ||
|
||
```bash | ||
pnpm install | ||
``` | ||
|
||
2. This command will update and install all necessary packages. | ||
|
||
<div align="right"> | ||
<a href="#quick-start-guide">↑ Back to Overview</a> | ||
</div> | ||
|
||
--- | ||
|
||
### Running the Project | ||
|
||
1. Start the POIDH app: | ||
|
||
```bash | ||
pnpm start | ||
``` | ||
|
||
Or, if you're running a development build: | ||
|
||
```bash | ||
pnpm dev | ||
``` | ||
|
||
2. The app should now be running locally! Check your terminal output for any additional information or errors. | ||
|
||
<div align="right"> | ||
<a href="#quick-start-guide">↑ Back to Overview</a> | ||
</div> | ||
|
||
--- | ||
|
||
### Submitting Pull Requests | ||
|
||
To contribute code, follow these steps: | ||
|
||
1. **Style Guide**: Please review the POIDH style guide to maintain consistency in the codebase. | ||
|
||
2. **Code Check**: Before submitting, make sure your code is formatted and linted. GitHub Actions will automatically build, lint, and format your pull request, highlighting issues if they exist. | ||
|
||
3. **Commit Titles and Descriptions**: Keep titles and descriptions concise yet informative to help reviewers understand your changes. | ||
|
||
4. **Build Command**: Don’t forget to run the following to ensure your build is up to date: | ||
|
||
```bash | ||
pnpm build | ||
``` | ||
|
||
5. **Pull Request Review**: After submitting, if you see a ❌, review the error logs under the “Actions” tab to identify any issues. | ||
|
||
<div align="right"> | ||
<a href="#quick-start-guide">↑ Back to Overview</a> | ||
</div> | ||
|
||
--- | ||
|
||
### Thank You! | ||
|
||
We appreciate your contribution to POIDH. Happy coding and thank you for helping to make POIDH even better! |
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
Oops, something went wrong.