https://github.com/design-sparx/scribble-vault
A note keeping appliction, built using Next 14, Mantine, Tiptap, JSON Server and SWR.
https://github.com/design-sparx/scribble-vault
json-server mantine-v7 next14 notes notes-app swr tiptap-editor
Last synced: 3 months ago
JSON representation
A note keeping appliction, built using Next 14, Mantine, Tiptap, JSON Server and SWR.
- Host: GitHub
- URL: https://github.com/design-sparx/scribble-vault
- Owner: design-sparx
- License: mit
- Created: 2023-12-21T19:39:40.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-21T19:30:03.000Z (over 1 year ago)
- Last Synced: 2024-05-21T20:42:55.072Z (over 1 year ago)
- Topics: json-server, mantine-v7, next14, notes, notes-app, swr, tiptap-editor
- Language: TypeScript
- Homepage:
- Size: 1.76 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Scribble Vauit
## About
A note keeping web application template using [Mantine](https://mantine.dev/), [Next 14](https://nextjs.org/), [Tiptap](https://tiptap.dev/) (WSIWYG rich text editor), [JSON server](https://github.com/typicode/json-server?tab=readme-ov-file#getting-started) and [SWR](https://swr.vercel.app/)
> Kindly note: Primarily this template is geared to be used with a backend or content management service and because of that I have
> added **json server** and a **db.json** on the root directory.
> I have already written SWR fetching data hooks that can serve as a base for your development.
## Quick start
#### Download
- Clone this repo git clone `https://github.com/design-sparx/scribble-vault.git`
- [Download from GitHub](https://github.com/design-sparx/scribble-vault/archive/refs/heads/master.zip)
#### Environment variables
Before installing, it in your project root directory, create an `env.local` file and paste the below.
```bash copy
NEXT_PUBLIC_BASEURL=http://localhost:8000
```
> Note: The above variable will help in the consumption of your JSON server endpoints.
#### Dev tools
You'll need to go ahead and install Node.js.
Once Node.js is installed, run npm install to install the rest of the template's dependencies. All dependencies will be
downloaded to the node_modules directory.
```bash copy
yarn install
```
Before running your Nextjs server, you must run your JSON server. This will serve your local web server
at http://localhost:8000, using the following command.
```bash copy
yarn json:serve
```
Now you're ready to modify the source files and generate new files. To automatically detect file changes and start a
local webserver at http://localhost:3000, run the following command.
```bash copy
yarn dev
```
Compile, optimize, minify and uglify all source files to build
```bash copy
yarn build
```