forked from akshat0047/UNDERDOGS-V2
-
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.
[Documentation] Update Readme.md akshat0047#6 done
Done: - Screenshot of the site - Introduction (Ask for it in the comment section) - To set-up the project - Links to the required technologies to refer (Eg.- git, HTML, CSS, JS) - Workflow for contribution
- Loading branch information
1 parent
9ed32a4
commit baf55ec
Showing
1 changed file
with
33 additions
and
7 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,11 +1,37 @@ | ||
# UNDERDOGS-V2 | ||
The version 3 of the official underdogs webapp | ||
|
||
LIBRARY USED: BOOTSTRAP 4.0 | ||
![Imgur](https://i.imgur.com/8OvljjRl.png) | ||
|
||
1- Contributions to enhance the design are invited | ||
2- Do not make changes to the members section | ||
3- Forms cannot be changed as google forms are used | ||
## Introduction | ||
|
||
CONTRIBUTORS | ||
-AKSHAT PANDE | ||
This repository contains the code of Official Website for **Underdogs Crew**, which is a **dance group** of **Amity University Lucknow**. | ||
|
||
We participate as a group as well as individuals in various dance competitions in and around Lucknow with a group of versatile dancers and new sets of choreographies. | ||
|
||
## Setup - to run the Underdogs website | ||
|
||
1) Run the command ```git clone https://github.com/akshat0047/UNDERDOGS-V2.git``` in your favoured command-line interface e.g. Terminal for Mac OS - there should now be a folder called **UNDERDOGS-V2** in your home directory or other folder of choice | ||
2) Open a browser of your choice (we recommend [Google Chrome](https://www.google.com/chrome/)) | ||
3) In your browser, click ```File + Open File```, at the top, and open index.html in your **UNDERDOGS-V2** folder (if using Mac, the keyboard shortcut is Command + O) | ||
4) You should now be able to see the Underdogs website and all of its pages! | ||
|
||
## Technologies used | ||
|
||
- [Git](https://git-scm.com/) | ||
- [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML) | ||
- [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS) | ||
- [JS](https://developer.mozilla.org/en-US/docs/Web/JavaScript) | ||
|
||
## How to contribute | ||
|
||
1) Look at the **Pull requests** tab of this repo | ||
2) Click on an open issue and make sure it isn't assigned to someone else | ||
3) Assign yourself to the pull request | ||
4) Fork the repo | ||
5) Clone the repo | ||
6) Work on the pull request issue, asking the owner of the repo questions in the pull request, if unsure about anything | ||
7) Create a new branch in your local repo, with a descriptive name, that refers to the pull request i.e. git branch your-branch | ||
8) Push your changes to that branch i.e. git checkout your-branch | ||
9) Create a pull request - base repo: akshat0047/UNDERDOGS-V2 base: master <- head repo: your repo compare: your-branch | ||
10) Wait for the pull request to be merged by the owner of the repo - if there are any issues, contact the owner of the repo or wait for comments made by the owner of the repo | ||
11) If the pull request is approved, delete the branch you created |