Skip to content

Commit 02243f0

Browse files
committed
Deployment Done
1 parent 062b2d0 commit 02243f0

2 files changed

Lines changed: 82 additions & 8 deletions

File tree

Demo.png

5.06 MB
Loading

README.md

Lines changed: 82 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,93 @@
1-
![Demo](Demo.png)
1+
<h2 align="center">
2+
React Coding Website<br/>
3+
<a href="https://coders-garage.netlify.app/" target="_blank">Coders Garage</a>
4+
</h2>
25

3-
# Coders-Garage
4-
A react coding website made for the Summer of Innovation Web Development project.
5-
[Problem statement Link](https://drive.google.com/file/d/1N5pfnjgjo8eoB571Ia0KvBgDLbKP0SPG/view?usp=sharing)
6+
<div align="center">
7+
<img alt="Demo" src="./Demo.png" />
8+
</div>
69

7-
# To run the client
8-
```
10+
<br/>
11+
12+
<center>
13+
14+
[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com) &nbsp;
15+
[![forthebadge](https://forthebadge.com/images/badges/made-with-javascript.svg)](https://forthebadge.com) &nbsp;
16+
[![forthebadge](https://forthebadge.com/images/badges/open-source.svg)](https://forthebadge.com) &nbsp;
17+
</center>
18+
19+
<h3 align="center">
20+
🔹
21+
<a href="https://github.com/Samyc2002/Coders-Garage/issues">Report Bug</a> &nbsp; &nbsp;
22+
🔹
23+
<a href="https://github.com/Samyc2002/Coders-Garage/issues">Request Feature</a>
24+
</h3>
25+
26+
## TL;DR
27+
28+
You can fork this repo to modify and make changes of your own. Please give me proper credit by linking back to [Samyc2002](https://github.com/Samyc2002/Coders-Garage). Thanks!
29+
30+
## Built With
31+
32+
A coding website <a href="https://coders-garage.netlify.app/" target="_blank">Coders Garage</a> which has a Home page where questions are available, an IDE that can be used by anyone and has a user friendly interview platform. It has a soothing and minimal UI.<br/>
33+
34+
This project was built using these technologies.
35+
36+
- React.js
37+
- Node.js
38+
- Express.js
39+
- MongoDB
40+
- Material UI
41+
- CSS3
42+
- VsCode
43+
- Heroku
44+
- Figma
45+
46+
## Features
47+
48+
**📖 Multi-Page Layout**
49+
50+
**🎨 Styled with Material UI and CSS with easy to customize colors**
51+
52+
**📱 Fully Responsive**
53+
54+
## Getting Started
55+
56+
Clone down this repository. You will need `node.js` and `git` installed globally on your machine.
57+
58+
## 🛠 Installation and Setup Instructions
59+
60+
### To run the client
61+
62+
```bash
963
cd client
1064
npm i
1165
npm start
1266
```
1367

14-
# To run the server
15-
```
68+
Runs the client app in the development mode.\
69+
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
70+
The page will reload if you make edits.
71+
72+
## To run the server
73+
74+
```bash
1675
cd server
1776
npm i
1877
npm run dev
1978
```
79+
80+
Runs the server in the development mode.\
81+
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
82+
Consecutively, you can also see it running in your terminal.
83+
84+
## Usage Instructions
85+
86+
Open the project folder and Navigate to `/client/src/components/`. <br/>
87+
You will find all the components used and you can edit your information accordingly.
88+
89+
`/client/src/pages` has all the components arranged and organised in pages.
90+
91+
### Show your support
92+
93+
Give a ⭐ if you like this website!

0 commit comments

Comments
 (0)