Skip to content

Latest commit

 

History

History
146 lines (94 loc) · 4.65 KB

README.md

File metadata and controls

146 lines (94 loc) · 4.65 KB

All Contributors

Jahresbericht 2024

Welcome to the Jahresbericht 2024 repository! This project is built with Vite and React, providing a modern and fast development environment. Below are setup instructions for running the project locally and steps for deploying it to Netlify.

Prerequisites

Ensure you have the following installed on your machine:

  • Node.js (v18 or higher)
  • npm (usually included with Node.js)

Installation

  1. Clone the Repository

    git clone <your-repo-url>
cd <your-repo-name>

  2. Install Dependencies

    Run the following command to install all necessary packages:

    npm install

Running the Project

To start a local development server, use the following command:

npm run dev

This will start the development server, usually accessible at http://localhost:5173 (check the terminal output to confirm).

Building for Production

To build the project for production, run:

npm run build

The output will be generated in the dist folder, ready to be deployed.

Deploying to Netlify

Steps to Deploy

  1. Login to Netlify: Go to Netlify and log in to your account (or create one if you haven’t already).

  2. Create a New Site:

    • Click "New site from Git" and connect your GitHub (or other Git provider) account.
    • Select the repository for Project Name.

  3. Configure Build Settings:

    • Build Command: npm run build
    • Publish Directory: dist

  4. Deploy:

    • Click "Deploy Site". Netlify will automatically build and deploy your project.

Netlify Continuous Deployment

After the initial setup, every push to the main branch will automatically trigger a redeployment on Netlify, ensuring your site stays up-to-date.

Contributing

Before you create a pull request, write an issue so we can discuss your changes.

Contributors

Thanks goes to these wonderful people (emoji key):

Luise Brandenburger
Luise Brandenburger
💻 👀		 Jakob Sawal
Jakob Sawal
💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Content Licensing

Texts and content available as CC BY.

All rights reserved.

Credits

Made by

Supported by

Netlify Status

Netlify Status

Fonts

The fonts used in this project are not public. As a member of Technologiestiftung you can access them via

Github

This project uses *.woff files. Paste them into src/fonts