A web-based note-taking app with GitHub sync and Markdown support. (WIP)
Warning: TakeNote is still in active development. You can visit takenote.dev to see the work in progress, but your account and the notes you create are temporary will not be persisted. All data will be lost once GitHub integration is complete.
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.
Drag-and-drop notes into categories, instantly search through notes, and pin your favorites to the top.
TakeNote is made for the web, so you can use it anywhere without downloading anything.
Enjoy a beautiful, clean design reminiscent of your IDE with light and dark themes.
In progress!
"I think the lack of extra crap is a feature." β Craig Lam
Before working on TakeNote locally, you must create a GitHub OAuth app for development.
Go to your GitHub profile settings, and click on Developer Settings.
Click the New OAuth App button.
- Application name: TakeNote Development
- Homepage URL:
http://localhost:3000 - Authorization callback URL:
http://localhost:3000/api/auth/callback
Create a .env file in the root of the project, and add the app's client ID and secret.
CLIENT_ID=xxx
CLIENT_SECRET=xxxxChange the URLs to port
5000in production mode or Docker.
git clone [email protected]:taniarascia/takenote
cd takenote
npm iIn the development environment, an Express server is running on port 5000 to handle all API calls, and a hot Webpack dev server is running on port 3000 for the React front end. To run both of these servers concurrently, run the dev command.
npm run devGo to localhost:3000 to view the app.
API requests will be proxied to port 5000 automatically.
In production, the React app is built, and Express redirects all incoming requests to the dist directory on port 5000.
npm run build && npm run startGo to localhost:5000 to view the app.
Follow these instructions to build an image and run a container.
docker build --build-arg CLIENT_ID=xxx -t takenote:mytag .
docker run -p CLIENT_ID=xxx CLIENT_SECRET=xxxx NODE_ENV=development 5000:5000 takenote:mytagGo to localhost:5000 to view the app.
Note: You will see some errors during the installation phase, but these are simply warnings that unnecessary packages do not exist, since the Node Alpine base image is minimal.
To seed the app with some test data, paste the contents of seed.js into your browser console.
Run unit and component tests.
npm run testRun Cypress e2e tests.
npm run e2e:openExplanation the structure of files and directories within TakeNote.
βββ config/ # Webpack configuration
β βββ webpack.common.js # Webpack shared configuration
β βββ webpack.dev.js # Webpack development configuration (dev server)
β βββ webpack.prod.js # Webpack productuon configuration (dist output)
βββ cypress/ # End-to-end tests
βββ docs/ # Assets for documentation
βββ patches/ # Overrides for dependencies
βββ public/ # Files that will write to dist on build
βββ src/ # All TakeNote app source files
β βββ client/ # React client side code
β β βββ api/ # Temporary placeholders for mock API calls
β β βββ assets/ # Static assets
β β βββ components/ # React components that are not connected to Redux
β β βββ constants/ # Static values
β β βββ contexts/ # React context global state without Redux
β β βββ helpers/ # Helper functions
β β βββ router/ # React private and public routes
β β βββ sagas/ # Redux sagas
β β βββ selectors/ # Redux Toolkit selectors
β β βββ slices/ # Redux Toolkit slices
β β βββ styles/ # Sass style files
β β βββ tests/ # React Testing Library component tests
β β βββ types # TypeScript types
β β βββ index.tsx # Client side entry point
β βββ server/ # Node/Express server side code
β βββ handlers/ # Functions for API endpoints
β βββ middleware/ # Middleware for API endpoints
β βββ router/ # Route API endpoints
β βββ utils/ # Backend utilities
β βββ index.ts # Server entrypoint
βββ .editorconfig # Configures editor rules
βββ .gitattributes # Additional git attributes
βββ .gitignore # Lists files for git to ignore
βββ .prettierrc # Code convention enforced by Prettier
βββ .travis.yml # Continuous integration and deployment config
βββ CHANGELOG.md # List of significant changes
βββ cypress.json # Cypress configuration
βββ deploy.sh # Deployment script for Docker in production
βββ Dockerfile # Docker build instructions
βββ jest.config.js # Jest configuration
βββ LICENSE # License for this open source project
βββ nodemon.json # Nodemon configuration
βββ package-lock.json # Package lockfile
βββ package.json # Dependencies and additional information
βββ README.md
βββ seed.js # Seed the app with data for testing
βββ tsconfig.json # Typescript configuration
βββ tsconfig.test.json # Typescript test configurationTakeNote is possible thanks the all these open source languages, libraries, and frameworks.
| Tech | Description |
|---|---|
| Codemirror | Browser-based text editor |
| TypeScript | Static type-checking programming language |
| Node.js | JavaScript runtime for the backend |
| Express | Server framework |
| React | Front end user interface |
| Redux | Global state management |
| Webpack | Asset bundler |
| Sass | Style preprocessor |
| OAuth | Protocol for secure authorization |
| ESLint | TypeScript linting |
| Jest | Unit testing framework |
| Cypress | End-to-end testing framework |
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.
- Use non-default exports for components
- Imports are ordered and separated by built-in modules -> external modules -> internal modules -> css/assets/other
Thanks goes to these wonderful people:
- A big thank you to David Bock for logo design.
This project is open source and available under the MIT License.