Skip to content

Latest commit

 

History

History
164 lines (122 loc) · 6.23 KB

README.md

File metadata and controls

164 lines (122 loc) · 6.23 KB
Raw

Version Forks Stargazers Contributors Issues License


Logo

Web

The main web page for the D-guild
dsek.se

Report Bug · Request Feature

About

This repo contains code for our main web page. You can read more about the project in the wiki.

builtwith typescript svelte prisma zod expo

using node pnpm docker

(back to top)

Getting Started

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

Prerequisites

You need to install the following tools by following the instructions on their respective websites. If you're running Windows, it's highly recommended to first install WSL.

  1. Install Node.js: https://nodejs.org/en/download/
  2. Install pnpm: https://pnpm.io/installation
  3. Install Docker: https://docs.docker.com/get-docker/

Installation

  1. Clone the repo and change into the directory 
    git clone https://github.com/Dsek-LTH/web.git dsek-web && cd dsek-web
  2. Install dependencies 
    pnpm install
  3. Setup your local development database. You may need to run this command with sudo. Learn more here. 
    sh ./dev/setup_db.sh
  4. Start the development server. It should be available on http://localhost:5173. 
    pnpm dev

(back to top)

Development

The wiki contains a lot of useful information for developers. You can find it here. Note especially that VS Code is used and there are a few extensions you should install before starting development. These should be suggested by VS Code when you open the project for the first time, otherwise they can be found in .vscode/extensions.json.

(back to top)

Contributing

Any contributions you make are greatly appreciated. If you have a suggestion, please fork the repo and create a pull request. You can also simply open an issue using the links at the top.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the EUPL License. See LICENSE for more information.

(back to top)

Contact

Head of DWWW - [email protected]

Project Link: https://github.com/Dsek-LTH/web

(back to top)