Skip to content

Commit

Permalink
docs(README): link contribution guidelines
Browse files Browse the repository at this point in the history
- move developer info to CONTRIBUTING
- move miro design up in the README
  • Loading branch information
FabianUntermoser committed Sep 22, 2024
1 parent 126d2c1 commit 482a801
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 25 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ chore(deps-dev): bump eslint-plugin-unused-imports from 3.1.0 to 3.2.0 in /cms

The setup for this project consists of three main parts: the website (web), the content management system (cms), and the database (db). The website is built with Next.js, while the CMS is Strapi, and MySQL 8 is used for the database. You'll need Node.js with npm for both web and cms. If you want to start the applications without docker please refer to the specific Node.js versions indicated in the `.nvmrc` file or the `engines` field in `package.json`. However, we use Docker to facilitate the development process. Both the website and CMS have their own Dockerfile. All components are managed together in a docker-compose file.

For more information about the headless CMS used in this project, visit the official documentation: https://docs.strapi.io/

### Prerequisites

- Docker and Docker Compose
Expand Down
38 changes: 13 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@

# Overview

This is the relaunch of the new www.vim.org website. We have found a small team that will take on the
This is the relaunch of the www.vim.org website. We have found a small team that will take on the
beautiful task of rebuilding the website with current design and new concepts.

The new development should not take place behind closed doors, we want to
Expand All @@ -11,6 +10,13 @@ Soon there will be a test system where you can follow the current status success

Of course, we will involve you, the community, in the design by collecting ideas and feedback.

Please read the [contribution guidelines](CONTRIBUTING.md) if you want to help out.

### New Design

The link below leads to a publicly accessible Miro board that contains a first draft of the new website design:
https://miro.com/app/board/uXjVKobQViM=/?share_link_id=158721849826

# Build

Prerequisites
Expand All @@ -20,33 +26,16 @@ Prerequisites

### Getting started

Run the application locally with these make commands.
Run the application locally with the following commands.

```sh
# start prebuilt containers
make start

# or start containers for local development
make dev
```

This will setup default configuration (including dummy secrets),
install npm dependencies and start the application using docker on port `3000`.

### Build locally

The following steps must be carried out:
1. Copy contents of `.env.example` files on `root`, `root/cms` and `root/web` into `.env` file
2. Install npm dependencies with `npm install` in the `root`, `root/cms` and `root/web` folder.
3. Startup: `docker compose up`

For more information about the headless CMS used in this project, visit the official documentation: https://docs.strapi.io/

# New Design

The link below leads to a publicly accessible Miro board that contains a first draft of the new website design:
https://miro.com/app/board/uXjVKobQViM=/?share_link_id=158721849826

# Requirements

Add your requirements here:
Expand All @@ -66,21 +55,20 @@ Add your requirements here:
* The hashing of the user passwords is to be migrated to a hashing procedure that corresponds to the state of the art.
* The frontend/backend stack shall:
- should be maintainable and expandable in the future with reasonable effort
- be opensource based
- be Open Source based
- the components used should be vital
- shall be efficient with server resources


# Idea collection

This is a unfinished and unstructed list of ideas:
This is a unfinished and instructed list of ideas:

- Tutorial section
- Vim tips revival
- The vim tricks
- My personal ".vimrc", with annotations about motivations
- Blog posts and annountements for the maintainers and artive editors
- My personal `.vimrc`, with annotations about motivations
- Blog posts and announcements for the maintainers and active editors
- Link resource section
- "How to contribute" section
- Vim distributions for the various platforms

0 comments on commit 482a801

Please sign in to comment.