Welcome to the codebase for the GDSC-UPD website! This README file contains notes for data contributors and site developers in the sections to follow.
To add an event, project, or a member, go to the site's admin
page:
If you don't have access to the content management system (CMS) yet, ask for an invite from one of the developers on Discord.
Adding data is as simple as choosing a Collection
, clicking the New [Event/Project/Member]
button, filling up the necessary information, and clicking the Publish
button.
If you have any specific questions about the CMS, hit up Daryll on Discord!
Note
There's an in-depth guide for site developers on this site. If you're looking for more specific details beyond what's covered in this README, check it out!
If you don't have access to the Netlify dashboard yet, ask for an invite from one of the developers on Discord.
Clone the repository to your local machine like so:
git clone [email protected]:DSC-Diliman/dsc-website.git
Once a clone has been made, install packages using npm like so:
npm i
To generate the site's code, run npm run build
. Afterwards, run npm run dev
or npm start
to see the site in development or production mode, respectively.
Contributions are carried out in 3 main steps:
- Create a new branch via
git checkout -b [branch name]
. - Once you finish your work on the branch, create a pull request via the GitHub web interface. A deploy preview will pop up in the Netlify dashboard.
- If the deploy preview works as intended, ask one of the developers for a code review. Once your changes are approved, they can be merged into the
master
branch.
Technology | Purpose | Notes |
---|---|---|
React framework | v13, Documentation, Tutorial | |
JavaScript framework | v18, Documentation, React Icons | |
Type safety | v4, Documentation | |
Styling | v3, Documentation | |
Testing | Documentation | |
Design | Wireframe | |
Animation | Documentation |