Skip to content

Commit

Permalink
theme: add theme builder app
Browse files Browse the repository at this point in the history
  • Loading branch information
ammarahm-ed authored and thecodrr committed Aug 8, 2023
1 parent ed6d125 commit 380bfba
Show file tree
Hide file tree
Showing 21 changed files with 51,817 additions and 3 deletions.
3 changes: 2 additions & 1 deletion .commitlintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ const SCOPES = [
"misc",
"common",
"global",
"docs"
"docs",
"theme-builder"
];

module.exports = {
Expand Down
33 changes: 33 additions & 0 deletions apps/theme-builder/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
/build

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*

.now

__diff_output__

dist
public/workbox
scripts/secrets
test-results
.swc
56 changes: 56 additions & 0 deletions apps/theme-builder/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<p align="center">
<img style="align:center;" src="/resources/screenshots/web.png" alt="Notesnook theme builder screenshot" width="600" />
</p>

<h1 align="center">Notesnook Theme Builder</h1>
<h3 align="center">The theme builder app is built using React, Typescript & Javascript.</h3>
<p align="center">
<a href="https://app.notesnook.com/">Try it out!</a> | <a href="#developer-guide">Developer guide</a> | <a href="#build-instructions">How to build?</a> | <a href="../desktop/">Desktop app</a>
</p>

## Getting started

## Build instructions

> **Before you start, it is recommended that you read [the contributing guidelines](/CONTRIBUTING.md).**
### Setting up the development environment

Requirements:

1. [Node.js](https://nodejs.org/en/download/)
2. [git](https://git-scm.com/downloads)
3. NPM (not yarn or pnpm)

Before you can do anything, you'll need to [install Node.js](https://nodejs.org/en/download/) on your system.

Once you have completed the setup, the first step is to `clone` the monorepo:

```bash
git clone https://github.com/streetwriters/notesnook.git

# change directory
cd notesnook
```

Once you are inside the `./notesnook` directory, run the preparation step:

```bash
# this might take a while to complete
npm install
```

Now you can finally start the web app:

```bash
npm run start:theme-builder
```

If you'd like to build in production mode:

```bash
npm run build:theme-builder

# serve the app locally
npx serve apps/theme-builder/build
```
Loading

0 comments on commit 380bfba

Please sign in to comment.