Skip to content
This repository has been archived by the owner on Aug 3, 2024. It is now read-only.

Commit

Permalink
New readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Prospector authored Jun 19, 2024
1 parent bd49d6b commit d6f0761
Showing 1 changed file with 38 additions and 4 deletions.
42 changes: 38 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,41 @@
![knossos banner](https://user-images.githubusercontent.com/12068027/100479893-d9b5a380-30ac-11eb-9db9-0c09d400f13f.png)
<img src="https://github.com/modrinth/knossos/assets/6166773/79cb3584-5c78-4632-bb20-ea21ddb8f94e" alt="modrinth.com: knossos (web frontend)">

## Modrinth's center for its frontend service
# Modrinth.com

For contributing information, please see the knossos section of the [Modrinth contributing guide](https://support.modrinth.com/en/articles/8802215-contributing-to-modrinth#h_1bc6570903).
<img src="https://github.com/modrinth/knossos/assets/6166773/3b6e47e8-6b92-4702-b707-38a225982f96" alt="Screenshot of the Modrinth website's browse page for mods" align="right" width="50%">

For a detailed explanation on how things work in general, check out the [Nuxt.js docs](https://nuxt.com).
The Modrinth.com frontend, codenamed knossos, is the web interface used for interacting with Modrinth services, built with [Nuxt.js](https://nuxt.com/).

### Features
- Browsing for mods, data packs, resource packs, modpacks, and more hosted on Modrinth
- Uploading your own project to Modrinth
- Clean and modern interface that simplifies things enough for the layuser but with enough depth for a power user
- Save projects to a collection to come back to later
- Follow projects to get notifications when they update
- Fully open source under GPLv3[^1]!
- Many more features for interacting with Modrinth services

[^1]: Modrinth's logos, branding, and other trademarks are not free for use, see the [licensing section](#license) for more information.

## Contributing
You're welcome to help contribute to Knossos if you'd like! Please review our [contribution guide](https://support.modrinth.com/en/articles/8802215-contributing-to-modrinth) before attempting to contribute or make a pull request though.

## Development
To get started, install [pnpm](https://pnpm.io/). Then, run the following commands:

```
pnpm install
pnpm run dev
```

Once that's done, you'll be serving knossos on `localhost:3000` with hot reloading. You can run `pnpm run build` to build for a production server and `pnpm run start` to start the server. You can also use `pnpm run lint` to find any eslint problems, and `pnpm run fix` to try automatically fixing those problems.

If you've never used Nuxt before, check out the [Nuxt.js docs](https://nuxt.com/docs).

## License
The source code of the knossos repository is licensed under the GNU Affero General Public License, Version 3 only, which is provided in the file [LICENSE](https://github.com/modrinth/knossos/blob/master/LICENSE). However, some files are licensed under a different license.

Any files depicting the Modrinth branding, including the wrench-in-labyrinth logo, the landing image, and variations thereof, are licensed as follows:
> All rights reserved. © 2020-2024 Rinth, Inc.
Forking is permitted under the AGPLv3, however do be aware that you must remove all Modrinth branding, including logos, brand colors, background images, or anything else that is related to trademarks or copyrights held by Rinth, Inc.

0 comments on commit d6f0761

Please sign in to comment.