SSMCT Website

Website to advertise SSMCT and showcase its past achievements.

Visit the Website

Table of Contents

• Introduction
• Planned Features/Pages
• Features that may be added (To be discussed)
• Setup Instructions
• Technologies Used
• Contributing
• Resources
• License

Introduction

This project is the official website for SSMCT, designed to advertise the group and showcase its past achievements. It also provides a platform for members to share their writeups, stay updated with group activities, and learn more about the team.

Planned Features/Pages:

1. About Us
   • To introduce our group and what we do
   • Mention our events and bonding activities, etc.
2. Achievements
   • To showcase our achievements and past CTFs won
3. Members
   • To showcase all our members and their achievements
4. Blog
   • Updates on our activities or events, etc.
5. Writeups
   • Allow members to upload and share their own writeups
6. Image Gallery
   • To store images of our past events and activities
7. Login and Signup
   • To allow members to login and access member-only features. Uses Discord OAuth.
8. Uplaod Writeups/Post
   • To allow members to upload their writeups/blogs

Features that may be added (To be discussed)

1. Challenge Hosting & Creation Feature
2. Comment & Kudo Feature

Setup Instructions (Local Development)

Prerequisites

• Node.js and npm installed on your machine.

Running the Project (Backend/Frontend Team)

1. Clone the repository:

    git clone https://github.com/Singapore-Students-Merger/SSMCT_Website
   cd SSMCT_Website

2. Install the dependencies:

   npm install

3. Start the development server:

   npm run dev

4. Open your browser and navigate to http://localhost:3000.

Setup Instructions (Docker, For Integration Testing)

Prerequisites

• Docker and Docker Compose installed on your machine.

Running the Project

1. Clone the repository:

   git clone https://github.com/Singapore-Students-Merger/SSMCT_Website
   cd SSMCT_Website

2. Build and run the Docker container:

   docker-compose up --build

Stopping the Project

To stop the project, simply run:

docker-compose down

Building for Production

To build the production image:

docker-compose -f docker-compose.prod.yml up --build

Additional Notes

All dependencies and environment configurations are handled within the Docker containers, so you don’t need to manually install Node.js, npm, or other tools locally.

Technologies Used

• Docker (Containerization)
• (TBC)

Contributing

To Contribute, first assign yourself to one of the issues in the github issues tab, then:

1. Create a new branch:

   git checkout -b feature/my-feature

2. Make your changes and commit them:

   git commit -m "Add my new feature"

3. Push to the branch:

   git push origin feature/my-feature

4. Open a pull request.

Please read our contributing guidelines for more details.

Resources

• Figma Design File

License

This project is licensed under the MIT License - see the LICENSE file for details.