https://github.com/peteryangio/scroup
Web application that allows students on campus to organize study sessions with one another.
https://github.com/peteryangio/scroup
Last synced: about 1 year ago
JSON representation
Web application that allows students on campus to organize study sessions with one another.
- Host: GitHub
- URL: https://github.com/peteryangio/scroup
- Owner: PeterYangIO
- Created: 2018-10-21T10:11:00.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-29T04:46:21.000Z (over 7 years ago)
- Last Synced: 2025-04-03T21:33:14.970Z (over 1 year ago)
- Language: Java
- Homepage:
- Size: 446 KB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Setup Instructions
## Backend
The backend is built with Java, Servlets, and MySQL. You will need to use Maven for resolving dependencies.
### Using Maven
Maven allows projects to be plug and play. The IDE will detect the `pom.xml` configuration without you having to do much.
If you would like to add a dependency, find it on [Maven](https://mvnrepository.com) and paste in the `` XML snippet provided on the website.
### Server Set Up
For consistency with paths, we want to deploy on `localhost:8080/` instead of `localhost:8080/SCroup`.
To do this, go to the Servers folder in the Project Explorer, find `server.xml`
Edit the `` tag `path=` value to be `path=""`
**NOTE:** The first build will take significantly longer than subsequent builds. *Be patient!*
## Frontend
The frontend is built with React. You will need `npm` to compile the source files which can be found in `src/main/webapp`.
### Installing Node Modules
1. Make sure to have [npm](https://www.npmjs.com/get-npm)
2. `cd src/main/webapp`
3. `npm install`
4. `npm run build:dev` or `npm run build:prod` (details below)
### Build
During active frontend development, use `npm run build:dev` to quickly build changes; however this is a large and unoptimized file that should not be used in production
For deployment, use `npm run build:prod` which will shake out unnecessary sub-modules and minify the code
Note that in Eclipse you need to clean the project before building. Otherwise, .js files will not be updated automatically.