SWC-Software-Engineering-Club / SWE-Club-Website

https://swe-club.vercel.app
2 stars 0 forks source link

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

Software Engineering Club Website

Welcome to the Software Engineering Club's website project! This repository contains the source code and assets for our club's website.

Table of Contents

Introduction

The purpose of this project is to build our clubs website all while learning valuable technologies in a team setting.

Prototype

For the remaining process of our development please refer to our figma design. Have it open in another tab or on the side.

Figma file: https://www.figma.com/file/EPaawjZXvU7kfQxx33G0kc/SWECLUB-website?type=design&node-id=0-1&mode=design&t=nMJV5E9NhVDA8VYU-0

Getting Started

Installation

  1. Clone the repository:

    • Create a folder named swe-club on your desktop home
    • Open up your console and use ls to list all your folders.
    • You need to find the swe-club folder you created and cd into it by cd swe-club this will put you into the folder.
    • Next run the following git clone command down below. this will clone our clubs project into your new folder.
    git clone https://github.com/your-organization/software-engineering-club-website.git
    • Verify that your swe-club folder has our codebase copied. If you see it is your good to go.
  2. Drag club folder into vscode or cursor:

  3. Install dependencies:

    • In terminal cd into club-app by cd club-app.
    • once your in club-app, run the command below to install necessary packages
    npm install

Running Locally

Start the development server:

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Collaboration

As a team we will collaborate by pair programming. Tickets/ tasks will be created where you can choose what you will work on.

Development guidelines

For the duration of the project we will not work directly into the main. We will always create a sepearate branch to work on our tasks. Once we complete our tasks, you will create a PR and have a PM or I review it and approve it before it gets merged into main.

refer to this git tutorial if you gte stuck: https://www.youtube.com/watch?v=jhtbhSpV5YA

Deploy on Vercel

Once we finish our project we will deploy with 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.

Learn More

To learn more about Next.js, take a look at the following resources:

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