-
Notifications
You must be signed in to change notification settings - Fork 3
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
1 parent
548b241
commit 52d626b
Showing
2 changed files
with
69 additions
and
56 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,8 +1,63 @@ | ||
# Contributing | ||
[asdf-vm]: https://asdf-vm.com/ | ||
|
||
When contributing to this repository, please first discuss the change you wish | ||
to make via issue, email, or any other method with the owners of this | ||
repository before making a change. | ||
# 🚀 Getting Started | ||
|
||
Please note we have a [Code of Conduct](CODE_OF_CONDUCT.md), please follow it | ||
in all your interactions with the project. | ||
These instructions will get you a copy of the project up and running on your | ||
local machine for development and testing purposes. | ||
|
||
## 📥 Prerequisites | ||
|
||
The following software is required to be installed on your system: | ||
|
||
- [Node.js 16.13+](https://nodejs.org/en/download/) | ||
|
||
We recommend using [asdf version manager][asdf-vm] to install and manage all the | ||
programming languages' requirements. | ||
|
||
## 🔧 Setup | ||
|
||
Install all dependencies. | ||
|
||
``` | ||
npm install | ||
``` | ||
|
||
Then, create your local environment file and fill in all the required details. | ||
|
||
``` | ||
cp -n .env.sample .env.local | ||
``` | ||
|
||
## 🔨 Development | ||
|
||
Starting the development server. | ||
|
||
``` | ||
npm run develop | ||
``` | ||
|
||
Test your code against common guidelines. | ||
|
||
``` | ||
npm run test | ||
``` | ||
|
||
Lint your code. | ||
|
||
``` | ||
npm run lint | ||
``` | ||
|
||
Format your code. | ||
|
||
``` | ||
npm run format | ||
``` | ||
|
||
## 🔗 References | ||
|
||
You can use these resources to learn more about the technologies this project | ||
uses. | ||
|
||
- [Getting Started with React](https://reactjs.org/docs/getting-started.html) | ||
- [Learn Next.js](https://nextjs.org/learn). |
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
52d626b
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs: