Skip to content
This repository was archived by the owner on Aug 19, 2023. It is now read-only.

Commit 057b49b

Browse files
Readme Updated
1 parent 3f0ddd7 commit 057b49b

File tree

1 file changed

+57
-1
lines changed

1 file changed

+57
-1
lines changed

README.md

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,58 @@
11
# spider-tronix.github.io
2-
[Main Website](https://spider.nitt.edu/)
2+
3+
Our portfolio to showcase what we do. And also a hobby project to practice Web Development for our members.
4+
5+
- Visit the portfolio [here](https://spider-tronix.github.io)
6+
- Visit our **main official website** [here](https://spider.nitt.edu)
7+
8+
### About Us
9+
10+
> Spider, the Research and Development club of [NIT Trichy](https://www.nitt.edu), is a cluster of like-minded individuals pursuing projects in some of the booming technology sectors. The Tronix profile is a Spider division wherein we majorly work on the lines of Embedded Systems, Electronics, IoT, Robotics and Simulation, Control Systems, Solid Modelling, Computer Vision, Artificial Intelligence, and many more. Apart from the R & D projects, we conduct a uCON (mu-CON) workshop exclusively for the first years of NIT Trichy every year. Generally, the workshop happens in the mid of the odd semester. Also, we conduct an event named CRE-8 in the middle of even semester every academic year exclusively for first years at college.
11+
> Check out our [Github organization](https://github.com/orgs/spider-tronix/) to see what we do.
12+
13+
### Technologies
14+
15+
The portfolio uses a number of web development tech:
16+
17+
* [ReactJS](https://reactjs.org/) - React is an open-source, front end, JavaScript library for building user interfaces or UI components.
18+
* [Bootstrap](https://getbootstrap.com/) - Bootstrap is a free and open-source CSS framework directed at responsive, mobile-first front-end web development.
19+
* [jQuery](https://jquery.com/) - jQuery is an open-source, free JavaScript library designed to simplify HTML DOM tree traversal and manipulation, as well as event handling, CSS animation, and Ajax
20+
21+
### Repository Info
22+
23+
* ```master``` branch has the source files for the React app.
24+
* ```gh-pages``` branch has the files for production (hosting on Github Pages).
25+
26+
### Requirements
27+
- [**Node.js**](https://nodejs.org/en/) version same or greater than ```v12.8.2```.
28+
- [**npm**](https://www.npmjs.com/) version same or greater than ```v6.14.5```.
29+
30+
### Installation
31+
32+
- Clone the ```master``` branch on your local.
33+
- Change the directory(cd) to the local cloned directory.
34+
- Give command ```npm install```
35+
- Finally, to start react-app give ```npm start```
36+
37+
```cmd
38+
$ git clone [Repo url]
39+
$ cd spider-tronix.github.io
40+
$ npm install
41+
$ npm start
42+
```
43+
- Wait for some time and automatically, the browser should open with ```localhost:3000```.
44+
45+
### Building
46+
47+
By default, the react-app is set to push the changes to ```gh-pages``` branch after building. Hence, just building the app is required.
48+
49+
To build:
50+
```cmd
51+
$ npm build
52+
```
53+
54+
### Todos
55+
56+
- Handle other error cases for the [Github API](https://docs.github.com/en/free-pro-team@latest/rest) response.
57+
58+
## **Ideate. Innovate.**

0 commit comments

Comments
 (0)