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

Updating README.md #44

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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: 36 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,38 @@
# Explorer
## Description
This is the Explorer website. The goal of the project is to empower students in their journey through Computer Science. It acts as a collection of resources, ideas, books, clubs and more with the aim of enabling students to excel in their roles and build a strong foundation in Computer Science. Whether you are a beginner or more experienced CS student, there is always room to deepen your knowledge, and Explorer is your companion to do just that.

## Table of Contents
- [Description](#description)
- [Getting Started](#getting-started)
- [Important Contributions](#important-contributions)
- [ToDo](#todo)
- [Contribution Steps](#contribution-steps)
- [Handling Issues](#handling-issues)

**Production:** https://explorer-kd.herokuapp.com/

**Develop:**
https://explorer-chi.vercel.app/
https://explorer-chi.vercel.app

## Getting Started
To access the project, simply click this link: [Explorer-Website](https://explorer-kd.herokuapp.com/)

Within the website, you can do the following:
* Navigate to the resources tab: View different resources and courses that will expand your CS knowledge.
* Navigate to the books tab: View different books contributers recommend to prepare you for a career in industry.
* Navigate to the Clubs & Societies tab: View different clubs to get involved in at the University level to surround yourself with like minded individuals, network, and build your CS toolbox.
* Navigate to the Wall of Fame: View the important contributors who have made this project happen.

<!--**Production:**
https://explorer-kd.herokuapp.com/-->

## Contributions to this repo are WELCOME ⚡️🙌🏻
## Important Contributions
- :art: give suggestions on how to improve the UI design
- :hammer: try to break the website by testing it to find any bugs. If you find any, check if there is an issue already open for it, if there is none, then report it
- 🤸🏻 If you're new to open-source contributions, then you can simply start by picking up a **ToDo** given below 😊

## ToDo 🤸🏻
## ToDo
- [] Weekly Email regarding oppurtunities (Newsletter)
- [] Add functionality to the books section
- [] Resturant/food places nearby with deals
Expand All @@ -28,7 +47,7 @@ https://explorer-kd.herokuapp.com/-->
- [] Make a game for directions of Chitkara University (**AR/VR/JavaScript WebApp**)
- [] Open Source section for others to showcase their projects

## Steps to be followed in order to make valid contributions ☘️
## Contribution Steps

**1.** Fork the [Explorer](https://github.com/KushalBhanot/Explorer) repo by clicking on the fork button on the top of the page. This will create a copy of this repository in your account.

Expand All @@ -53,4 +72,17 @@ https://explorer-kd.herokuapp.com/-->
**6.** Create a Pull Request 🤟🏻
<br>If you go to your repository on GitHub, you’ll see a `Compare & pull request` button. Click on that button. We'll review your code and merge it if it passes all the tests ❤️

## Handling Issues
Fixing issues that arise is an important way you can contribute to the open source project.

Steps to fix issues:
* Navigate to the [Issues-Page](https://github.com/KushalBhanot/Explorer/issues)
* View any open issues
* Look into the problems and make fixes
* Commit fixes
* Push fixes to GitHub
* Create Pull Request
* The team will then approve issue fixes as long as all tests are passed
* Issues closed

[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com)