CollegeNetworkFrontend is the frontend repository, a detailed description of CollegeNetwork and its goals can be found in CollegeNetwork which is the API repository for CollegeNetworkFrontend.
- Install NodeJS and NPM (or PNPM or yarn)
- Clone this repository
cd
into the repository
Once you've created a project and installed dependencies with npm install
(or PNPM install
or yarn
), start a development server:
npm run dev
# or start the server and open the app in a new browser tab
npm run dev -- --open
The frontend can now be found at localhost:3000
but will not work fully without
also installing CollegeNetwork.
Before creating a production version of your app (currently on a simple Node server), install an adapter for your target environment. Then:
npm run build
You can preview the built app with
npm run preview
, regardless of whether you installed an adapter. This should not be used to serve your app in production.
TODO: Expand