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

Latest commit

 

History

History
53 lines (36 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

53 lines (36 loc) · 1.44 KB

Contributing to Meower

Branch information

The main branch where development takes place is develop. The master branch is what you see at https://app.meower.org, and is merged into for each release.

Branches are usually named like username-branch, where username is a short version of your username (like cst, tnix, et.), and branch is the branch name.

Setting up your development environment

Requirements:

  • node.js and npm or some other package manager
  • git and some knowledge of it
  • Preferably understanding of JavaScript and node.js, among us other things

To clone and run a development server on your machine (that autoupdates when you modify files):

git clone https://github.com/meower-media-co/Meower-Svelte
cd Meower-Svelte
npm install
npm run dev:routify (in a separate terminal)
npm run dev

Then in a separate shell:

npm run dev:routify

(Typically you usually also create a new branch for your work:)

git branch person-branch
git checkout person-branch

For one-time building:

npm run build

If your branch is online (not local), it will also be available in built form at [branchname].meower-svelte.pages.dev. A bot will post a comment about it when creating a PR.


Relevant bit of information from the original readme:

Recommended IDE Setup

VS Code + Svelte.