42 Vienna Student Council Official Website

Welcome to the official repository for the 42 Vienna Student Council Website! This project aims to facilitate communication between students and staff, providing an anonymous way to express concerns and feedback. We have decided to open source this project for greater transparency and to encourage contributions from every student.

Table of Contents

• About the Project
• Tech Stack
• Getting Started
• Usage
• Contributing
• License
• Contact

About the Project

The decision to start this project was sparked by the need to facilitate communication between students and staff. The 42 Vienna Student Council Website gives you an anonymous way to express your concerns.

Tech Stack

The application is containerized and built with Docker Compose (see doc). The technology stack includes:

• Frontend / Backend: Remix (TypeScript) (doc)
• Database: PostgreSQL

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

Make sure you have the following installed:

• Docker
• Docker Compose

Installation

1. Clone the repo:

git clone https://github.com/42-student-council/website.git
cd website

2. Create your .env file and add the necessary variables (See DOTENV for details).
3. Run make dev to build and run the containers. (See MAKEFILE for details on the commands).
4. The app should now be running on http://localhost:5173

Usage

To use the app, navigate to http://localhost:5173 in your web browser. From there, you can test the functionality.

Contributing

Contributions are what make open source such an amazing place to learn, inspire and create. Any contributions are greatly appreciated.

See CONTRIBUTING for more information on how to get started.

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

Contact

Click here to join our development Discord server.