Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Made necessary changes to the README setup #3

Merged
merged 3 commits into from
Oct 8, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 29 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,35 @@
There's one page application that can show you monotone color palets with different shades (S and L)
The base idea is to get the hue from user and use that to create the pallet,

## Getting Started

In the project directory, you can run the application by simply starting it up:

### `npm start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.\
You will also see any lint errors in the console.
### Setting up

- In order to run the application on your local machine, follow the steps given below:

1. Install Node.js from [https://nodejs.org/en/]
2. Clone the repository. You can paste the below command in your local shell/terminal.

```sh
git clone https://github.com/SscSPs/color.git
```
3. Enter the local directory

```sh
cd color
```
3. Install the required npm packages

```sh
npm install
```
4. Start the application
```sh
npm start
```
This runs the application in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.\
You will also see any lint errors in the console.

# Contributions

Expand Down