mausconi / takenote

📝 A web-based note-taking app with GitHub sync and Markdown support. (WIP)

A web-based note-taking app with GitHub sync and Markdown support. (WIP)

Simple

TakeNote was made by developers for developers - a simple, plain-text note-taking app for the web with Markdown support. What you see is what you paste. No WYSIWIG, no formatting pasted from the web, and no features you don't need or want.

Organized

Drag-and-drop notes into categories, instantly search through notes, and pin your favorites to the top.

Beautiful

Beautiful, clean design with light and dark themes.

Sync to GitHub

In progress!

Reviews

"I think the lack of extra crap is a feature." — Craig Lam

Setup

Local authentication

In order to work on TakeNote locally, you must create your own local Auth0 application.

• Create Auth0 account
• Create application with the following settings:
  • Domain: .auth0.com
  • Application Type: Single Page Application
  • Allowed Callback URLs: http://localhost:3000
  • Allowed Web Origins: http://localhost:3000
  • Allowed Logout URLs: http://localhost:3000
  • Allowed Origins (CORS): http://localhost:3000
• Change config.json to:

{
  "domain": "your-username.auth0.com",
  "clientId": "your-client-id"
}

• Go to Universal Login - Select "New".
• Ensure "GitHub" permissions is the "Connections".

Install

git clone [e-mail]:taniarascia/takenote
cd takenote
npm i

Run

npm start

Run in Docker

docker build -t takenote .
docker run -p 80:80 takenote

Seed data

To seed the app with some test data, paste the contents of seed.js into your browser console.

Contributing

TakeNote is an open source project, and contributions of any kind are welcome! Open issues, bugs, and enhancements are all listed on the issues tab and labeled accordingly. Feel free to open bug tickets and make feature requests. Easy bugs and features will be tagged with the good first issue label.

The project is written in TypeScript, React and Redux. TypeScript is set to strict mode, with no implicit any allowed. The formatting style for the project is set by Prettier.

Contributors

Thanks goes to these wonderful people:

Tania Rascia 💻 🤔 🐛	hankolsen 💻 🐛 ⚠️	Joseph Perez 💻	Paul 💻 ⚠️	Martin Rosenberg 💻 🐛 🚧	Melissa 💻	Jason Towle 💻
Mark Erikson 🤔	Alphonse Bouy 🐛	dave2kb 🎨 🤔	Devin McIntyre 💻	Jeffrey Fisher 🐛	Alex Dong 💻	Publicker 💻
Jakub Naskręski 💻 🐛 ⚠️	Benny O 💻	Justin Payne 💻	marshmallow 🚧	Jose Felix 💻	Nikolay Kirsh 💻	Mudassar Ali 💻
Nathan Bland 🐛 💻	Craig Lam 💻 🐛 ⚠️	Ashinze Ekene 🐛 💻	Harry Sullivan 💻	Mauricio Martínez 💻	Black-Hole 💻	Frank Blendinger 💻

Acknowledgements

• A big thank you to David Bock for logo design

Author

• Tania Rascia

License

This project is open source and available under the MIT License.