https://github.com/devcom-iitb/resobin
Course resources by the insti for the insti.
https://github.com/devcom-iitb/resobin
antd hacktoberfest hactoberfest2021 react redux-toolkit
Last synced: 30 days ago
JSON representation
Course resources by the insti for the insti.
- Host: GitHub
- URL: https://github.com/devcom-iitb/resobin
- Owner: DevCom-IITB
- License: mit
- Created: 2021-04-06T16:41:43.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-03T16:48:05.000Z (about 1 year ago)
- Last Synced: 2024-08-03T18:01:08.942Z (about 1 year ago)
- Topics: antd, hacktoberfest, hactoberfest2021, react, redux-toolkit
- Language: JavaScript
- Homepage:
- Size: 11.4 MB
- Stars: 10
- Watchers: 2
- Forks: 25
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# `ResoBin` - Easily Share Course Material
## Requirements
* React 17+
## Getting started
* Note: Enviroment variables are located [here](https://drive.google.com/drive/folders/1HCzepWZyzKJg0-yOyt4ZW46gO3z4-mHv?usp=sharing), and will only be accessible to the core developers.
* Before starting, make sure to [install Yarn](https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable). Also, **avoid** using npm in this repository.
### Development
* Clone this repository
```powershell
git clone https://github.com/wncc/ResoBin.git
cd ResoBin
```
* Install dependencies:
```powershell
yarn install
```
* Copy the environment variables to the base directory (current directory)
* Finally, run the development server:
```powershell
yarn start
```
* The frontend server runs at [`http://localhost:3000`](http://localhost:3000), and might take a few minutes to start.
### Production
* Build the project
```powershell
yarn build
```
* Serve the `/build` directory using your webserver (Nginx or Apache)
### Production (deployment with Docker)
* Build & tag the image file
```powershell
docker build --rm -f Dockerfile -t resobin:latest .
```
* Run the image file
```powershell
docker run --rm -d -p 80:80 resobin:latest
```