forked from anitab-org/anitab-org.github.io
-
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.
docs: Created a new GitHub Wiki page that includes the "Setup and Ins…
…tall" (anitab-org#64)
- Loading branch information
1 parent
52dc642
commit e0da8ad
Showing
2 changed files
with
49 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 |
---|---|---|
@@ -0,0 +1,49 @@ | ||
## Fork | ||
|
||
_**Note**: This is only needed if you want to contribute to the project._ | ||
|
||
If you want to contribute to the project you will have to create your own copy of the project on GitHub. You can do this by clicking the | ||
**Fork** button that can be found on the top right corner of the [landing page]([https://github.com/anitab-org/anitab-org.github.io]) of the repository. | ||
|
||
|
||
## [](https://github.com/anitab-org/anitab-org.github.io/wiki/Fork,-Clone-&-Remote#clone)Clone | ||
|
||
_**Note**: For this you need to install [git](https://git-scm.com/) on your machine. You can download the git tool from [here](https://git-scm.com/downloads)._ | ||
|
||
- If you have forked the project, run the following command - | ||
|
||
`git clone https://github.com/YOUR_GITHUB_USER_NAME/anitab-org.github.io` | ||
|
||
where `YOUR_GITHUB_USER_NAME` is your GitHub handle. | ||
|
||
- If you haven't forked the project, run the following command - | ||
|
||
`git clone https://github.com/anitab-org/anitab-org.github.io` | ||
|
||
## [](https://github.com/anitab-org/anitab-org.github.io/wiki/Fork,-Clone-&-Remote#remote)Remote | ||
|
||
_**Note**: This is only needed if you want to contribute to the project._ | ||
|
||
When a repository is cloned, it has a default remote named `origin` that points to your fork on GitHub, not the original repository it was forked from. To keep track of the original repository, you should add another remote named upstream. For this project it can be done by running the following command - | ||
|
||
`git remote add upstream https://github.com/anitab-org/anitab-org.github.io` | ||
|
||
You can check that the previous command worked by running `git remote -v`. You should see the following output: | ||
|
||
``` | ||
$ git remote -v | ||
origin https://github.com/YOUR_GITHUB_USER_NAME/anitab-org.github.io (fetch) | ||
origin https://github.com/YOUR_GITHUB_USER_NAME/anitab-org.github.io (push) | ||
upstream https://github.com/anitab-org/anitab-org.github.io.git (fetch) | ||
upstream https://github.com/anitab-org/anitab-org.github.io.git (push) | ||
``` | ||
## Install | ||
1. Latest stable version of NodeJs [here](https://nodejs.org/en/download/). | ||
2. Install [yarn]([https://classic.yarnpkg.com/en/docs/install#windows-stable](https://classic.yarnpkg.com/en/docs/install#windows-stable)). | ||
3. Run `node -v` and `yarn -v`. If you get the version number, then the installation was successful. | ||
|
||
To get the frontend running locally: | ||
|
||
- Clone this repository | ||
- `yarn` to install all required dependencies | ||
- `yarn start` or `npm start` to start the local server |