Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add steps for quickly getting started for local dev #166

Merged
merged 1 commit into from
May 7, 2024
Merged

docs: add steps for quickly getting started for local dev #166

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,25 @@ Here is a rough overview of steps required when contributing code:
- `npm start` runs without introducing new ESlint warnings or errors
- Squash any non-atomic local commits (e.g. any "work in progress" type commits) before pushing up your PR

## Getting started for local development

1. Clone the repo: `git clone git@github.com:makeup/makeup-js.git`
2. Change into the project directory: `cd makeup-js`
3. Run `npm i`
4. Run `npm start` to start the development server

This should perform a full build and launch your default browser and navigate to http://localhost:3000/, pointing to the
documentation root. Any changes you make to the source files should trigger a rebuild and refresh the browser.

## Project Organisation

The project is a mono-repo organised into 3 distinct groups of packages, in the following hierarchy:

1. Core Modules
2. UI Modules
3. HTMLElement Modules (aka Web Components) - coming soon
3. Custom Elements (a.k.a. Web Components) - coming soon

UI inherits from Core, and HTMLElements inherit from UI.
UI inherits from Core, and Custom Elements inherit from UI.

A top level `/docs` folder contains the src files for the static website (served via GitHub Pages).

Expand Down
Loading