Your notebook with superpowers
Insculpo is a note taking app that puts actually taking notes first , reminiscent of the physical notebooks we all know and love.
Taking the idea of an old school notebook into mind, Insculpo is designed to be local first and entire offline capable so you can have access to your notes at any and all times, With support for other devices for syncing on the roadmap as well.
Insulpo uses pnpm as the primary package manager.
-
node (however you install node on your system)
proto install node nvm install latest
-
pnpm
npm install -g pnpm@latest
Get up an running developing Insculpo locally
- Clone the Repo
git clone https://github.com/Insculpo.git
- Install packages
pnpm install
- Run in development environment
pnpm dev
Insculpo by nature doesn't cover a large scope but there are things that are essential to a proper note taking app
- Mobile Client
- Web Client
- Synchronization
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
Please bear in mind that all features being requested will have to undergo a vetting process and will have to be agreed to meet the overall goals of the project to be accepted.
-
Fork the Project
-
Create your Feature Branch (
git checkout -b feature/AmazingFeature
) -
Commit your Changes (``git commit -m 'Add some AmazingFeature'```)
-
Push to the Branch (
git push origin feature/AmazingFeature
) -
Open a Pull Request
This project wouldn't be possible without the following packages and as such I am grateful for their work