Hello! Welcome to the website for the Filipino Orginization here at UCSD. This project was a collaborative effort between a team of developers and designers that started early 2024, with the first iteration of the site releasing later that year in the fall. In this README you will find an overview of the project, steps to contribute, and setup.
You can find all the open issues under the "Issues" tab. Choose one of the issues and implement that feature following the steps described here. Whenever you open a pull request (step 4 in the steps described), make sure you add the corresponding issue to the PR.
Here's how you can get involved:
-
Fork this Repository: Start by forking this repository to your GitHub account.
-
Create a New Branch: Develop your feature or work on a task in a new branch. Be sure to name it appropriately, reflecting the task you're working on.
-
Commit & Push: Make your changes, commit them, and push your branch to your forked repository.
-
Open a Pull Request: Once you're ready to contribute, open a pull request from your branch to this main repository. Describe your changes, and our team will review it.
-
Collaboration: Engage in discussions within the pull request and make any necessary revisions based on feedback from the devs.
Pre reqs: Ensure that node.js is installed on your device. Link to download if you have not done so:(https://nodejs.org/en/download/package-manager)
First, run the following command to install node_modules:
npm install
Second, create a .env file in the root directory of the project and paste the environment variables. IMPORTANT: Do not push any of the information from .env to GitHub. These keys could give unauthorized access to the database. Ensure that ".env" is added to .gitignore.
Third, run the development server:
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun devThis project uses next/font to automatically optimize and load Inter, a custom Google Font.
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
The google spreadsheet serves as the content management system. It stores all upcoming events. Please read this guide on how to fill it in.
- Please ensure events are in order in terms of date from top to bottom. Any events that are in the past may be deleted.
Finished a task and want to merge your changes with development branch?
Follow this:
- First, ensure your branch and development branch have the latest changes in your local repository
This command ensures that your local repo pulls the latest version from the remote repo.
git pull origin your-branch-name
Ensure your changes are stashed
git stash
Now switch to dev branch and ensure that it is up to date
git checkout development
git pull origin development
- Next, merge your branch with development
Ensure that your back on your branch, then run these commands to unstash your changes and merge with dev:
git pop
git merge origin development
- Resolve any conflicts if neccsary
In the event that conflicts emerge, git will notify you. You must resolve these manually.
- Push your changes
Push changes to your branch.
git add .
git commit -m "Task completion #"
git push origin your-branch-name
Next, go here on Github and make a pull request to merge your changes in your branch to development!