🌍 Our Club Website

An informational website created by us, about us, the Computer Science Club @ Skyline College.

🔗 Come and visit us live @ skycs.club & skycsc.vercel.app

Will serve stuff like showcases for our projects, social media links & connections, Discord + GitHub integrations, a photo album?, a blog?, resources and intern opportunities, and whatever else our club would want to show to the world.

🙋‍♂️ We encourage all club members to contribute in any way to our website domain!

📊 Repository Contribution Activity

🔰 Quick Setup / Getting Started

Want to help design and add stuff to our project? Setup is easy and merely takes 5 minutes!

1. Clone this repository locally to your computer using Git.

• You can do so by clicking the green <> Code button above, copying the URL, then using the git clone <URL> command in a terminal
• Be sure to open your terminal to somewhere easy to access, like your Desktop or Documents folder.

2. Open the cloned folder in an IDE of your choice. Then via your terminal, cd into the directory of said folder.

• If using an external, standalone command-line shell, use the cd command like so:

cd Documents\project.ClubWebsite-live"

• Alternatively, if you use VSCode: after opening the folder, you can open a built-in Terminal (via top-left bar); it will automatically navigate itself to the currently open directory. (see below)

3. For this project, the only user-installed dependancy is the 📘Node.js runtime.

4. After installing Node.js, run the following command in the directory of the downloaded project to install our project's required dependencies, which includes the Next.js framework:

npm install

• We recommend installing the yarn package installer as well via npm install --global yarn!

• After installation, you should now see a new folder node_modules with said dependancies.

5. Now that we have everything we need (libraries), you can now test-run and host the website on your local computer using:

npm run dev

# or if you installed yarn

yarn dev

Steps 4 & 5 can be seen here:

• With it running, open http://localhost:3000 in any browser to see your locally hosted website. This URL will also be displayed to you in the terminal after running Step 5).

• Congrats! You can experiment now by editing the home page's components; modifying the files under src/components. The page auto-updates every time you save the file.

💡 After this initial setup, you only need Step 5) when editing the project in the future.

🗃️ Important Resources and Documentation

• Our project uses Node.js, the JavaScript runtime engine that powers the logic of our website.

• Our project uses React.js, our website's core HTML/TypeScript-orientated structuring framework.

• Our project uses Tailwind CSS, our website's core CSS styling library.

• Our project uses Framer Motion, a comprehensive, production-ready animation library for React.

• Our project uses Vercel, a cloud service that provides the infrastructure to integrate, build, scale, and deploy our website.

🧠 To specifically 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.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

⚙️ Important Technical Details

This is a Next.js project bootstrapped with create-next-app.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.js.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

🔺 Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.