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

vaibhav secondcycle #25

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions .env
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
REACT_APP_FIREBASE_KEY = AIzaSyAKJInd3cuF_UIhPuz0kHIHruzZet7DNjM
14 changes: 14 additions & 0 deletions .firebase/hosting.YnVpbGQ.cache
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
asset-manifest.json,1650642383306,79ddc81e0f6932355633e3b42a7d22e6d62ee394261c1e83809ee47f445b370c
index.html,1650642383306,a2c35f87e8705cc2ac6c40dddb66bdcd384b0a26f91d0380d593332a77adc358
manifest.json,1650187099981,aff3449bdc238776f5d6d967f19ec491b36aed5fb7f23ccff6500736fd58494a
robots.txt,1650187102652,bfe106a3fb878dc83461c86818bf74fc1bdc7f28538ba613cd3e775516ce8b49
static/css/main.c4a00ecb.css,1650642383319,75ded67df91ee2ef7344c8a710bcbf2392a501ca9e271681eac560ffb20b14fd
static/css/main.c4a00ecb.css.map,1650642383320,4c2c56215492479b2e3cb276dd2c1a504bf6e6a7ec8c8cd7faeb7af18c87350e
static/js/main.cf957ac1.js.LICENSE.txt,1650642383319,95cfff0d80fe8c950e4635524b106edf7b8ed9c6a91c0498cb6f2440f661f48c
logo512.png,1650187102443,ee7e2f3fdb8209c4b6fd7bef6ba50d1b9dba30a25bb5c3126df057e1cb6f5331
favicon.ico,1650187096162,eae62e993eb980ec8a25058c39d5a51feab118bd2100c4deebb2a9c158ec11f9
logo192.png,1650187102351,3ee59515172ee198f3be375979df15ac5345183e656720a381b8872b2a39dc8b
static/media/trying.507a41b83ca4cdf0a589.jpg,1650642383319,2e4f00412146656b04d70e64003506db33fb9facacc5aace98b14dd73edefa34
static/js/main.cf957ac1.js,1650642383320,4fc1c00acc75b545e836b45438559654256badbcfdca7ee6ced64e8899ebff72
static/media/712.3a557890eb3eac29b2f4.png,1650642383323,04b1bb896b982b8c45412ab707f05d579609090550d37c4b61ef754fce9e4e20
static/js/main.cf957ac1.js.map,1650642383322,ff87f6d5d085da3bc8f44d466cec848144e7125adaa22a4c2598d8b171ee5088
5 changes: 5 additions & 0 deletions .firebaserc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"projects": {
"default": "secondcycle-bc49d"
}
}
15 changes: 0 additions & 15 deletions .github/pull_request_template.md

This file was deleted.

23 changes: 23 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
/build

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
176 changes: 55 additions & 121 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,124 +1,58 @@
## Debugit 2022
[![Debugit](./lib/copsWeek_debugit.png)](https://hackalog.copsiitbhu.co.in/hackathon/debug-it-2022)
# SecondCycle
Deployed : [Website](https://secondcycle-bc49d.web.app)

## Introduction
Debugit is a week long hackathon open to ideas in a very literal sense. You can make anything from the projects' list we'll share or ignite the inquisitive Bob the Builder inside you to make something exciting and completely new!

## How to make a submission?
Submissions are to be made through GitHub Pull Requests. To know more about how to make a GitHub Pull Request you can refer the [Fundamentals of Git](https://www.youtube.com/playlist?list=PLLt4yMoVgczVgFcTzT60U5IXtNX1qjHL9) playlist which contains everything that you would need.

## Make sure to include
- A README.md file with your name, contact information, project description and how to run the code (and other necessary information).
- A folder containing a demo video of your project.

## Here is a detailed step by step walkthrough if you don't know how to make a Debugit submission.

- Create a fork of this [repository](https://github.com/COPS-IITBHU/Debugit_2022)
A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project.
1. Click on the fork icon in the repository that you might find at the top right corner.

Demo:
![](./lib/fork.png)

2. It will ask you what would you like to name the forked repository. By default they are named the same as the parent directory. Lets keep the name as it is.

Demo:
![](./lib/fork_name.png)

- Clone the repository that you forked
1. Find the link which you would need to clone and copy it.

Demo:
![](./lib/clone_link.png)

2. Go to the directory in which you want to clone your repository and open the terminal.

Demo:
![](./lib/open_terminal.png)

3. Run the `git clone` command in the terminal (in case of windows, git bash terminal) and append the link that you copied.
```
git clone <repository_link>
```

Demo:
![](./lib/clone.png)

4. You will find that the repository is cloned in the directory.
- Now you can open the directory in vs code and play with the code and complete your project.
- After completing the project, its time to push your code:
1. Open the vs code (or any other editor of your choice) terminal in the project folder.
2. Create a new branch in which you want to push your code using the following code.
```
git checkout -b <branch_name>
```
You can name your branch whatever you like.

Demo:
![](./lib/create_branch.png)

3. Check which branch are you on using the `git branch` command.
```
git branch
```
4. The branch name with a `*` on it is the current branch. If it is different from the branch that you created, then switch to your branch using the `git checkout`
```
git checkout <branch_name>
```
5. You can check the status of the files using
```
git status
```
6. Add (Stage) all the files you want to upload using the `git add` command.
To add individual files run the following command:
```
git add <filename>
```
If you want to add all the files from your project directory you can run
```
git add .
```
It is recommended not to add the some directories like node_modules directory in your commit. You can prevent it by adding it in a `.gitignore` file (For more reference [here](https://www.w3schools.com/git/git_ignore.asp?remote=github)).

Demo:
![](./lib/add_files.png)

6. Commmit your code.
You can commit all your staged code (to the local git repository) using the `git commit` command
Run the following command:
```
git commit -m "first commit"
```
You can replace `first commit` with anything. It is actually a message to let you keep a brief track of what changes has been done in that commit.

Demo:
![](./lib/commit.png)

7. Push your code.
Push all of your commited code using the `git push` command.
Run the following command:
```
git push --set-upstream origin <branch_name>
```

Demo:
![](./lib/push.png)
Facing issues in finding a bicycle at the campus? Worry not!
SecondCycle strives to bridge the gap and bring sellers and buyers on the same platform.

## Technologies:

- [ ] ReactJS (with React Router) as the Javascript library
- [ ] TailwindCSS as the styling library
- [ ] Firestore as the database
- [ ] Firebase for authentication and hosting

I only set up Google Auth, as we need to signin with our institute ids only.

## Installation

### Prerequisite
Node must be installed on your device

To setup:
1. Clone this repo with:
```
git clone --branch vaibhav-secondcycle https://github.com/crsdvaibhav/Debugit_2022.git
```
2. Then go inside the DebugIT folder and open your code editor and in its terminal run(for dependencies):
```
npm install
```
3. Now run this in the terminal
```
npm start
```

Wait for the website to fire up on: http://localhost:3000/

### Some issues which I couldn't fix in the given time:
1. While login from mobile, instead of pop-up a new tab opens, causing user to click login twice(works perfectly on PC)
2. While navigating through different pages, you have to login again and again in the Profiles page.

Hope to clear these in upcoming days.

## About Me:

Hey! I am Vaibhav Pandey, fresher from the Chemical Engineering department.

Email: [email protected]

Instagram: @vaibhavpand3y








- Make the Pull Request and submit your code.
1. After you push your code, it gets uploaded to your forked directory and creates a new branch that you created.
2. If it notices any difference in the code of your forked repo and the parent repo. It automatically shows you an option to create a pull request.

Demo:
![](./lib/pull_request.png)

3. Write down a brief description of your project in the Pull Request description and give the PR a proper title and click on create pull request. Now GitHub might run some checks. If you pass all the checks, you are good to go.

Demo:
![](./lib/submission.png)


- Pat yourself on the back

![](./lib/pat.gif)

> All The Best 🎉🎉.
16 changes: 16 additions & 0 deletions firebase.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"hosting": {
"public": "build",
"ignore": [
"firebase.json",
"**/.*",
"**/node_modules/**"
],
"rewrites": [
{
"source": "**",
"destination": "/index.html"
}
]
}
}
Binary file removed lib/add_files.png
Binary file not shown.
Binary file removed lib/clone.png
Binary file not shown.
Binary file removed lib/clone_link.png
Binary file not shown.
Binary file removed lib/commit.png
Binary file not shown.
Binary file removed lib/copsWeek_debugit.png
Binary file not shown.
Binary file removed lib/create_branch.png
Binary file not shown.
Binary file removed lib/fork.png
Binary file not shown.
Binary file removed lib/fork_name.png
Binary file not shown.
Binary file removed lib/open_terminal.png
Binary file not shown.
Binary file removed lib/pat.gif
Binary file not shown.
Binary file removed lib/pull_request.png
Binary file not shown.
Binary file removed lib/push.png
Binary file not shown.
Binary file removed lib/submission.png
Binary file not shown.
Loading