Skip to content

bytemakers/Noteslify

Noteslify

Your Privacy Friendly, Open Source. Alternative to EverNote.

Border

Made with ❤ By ByteMakers

A Notes Taking Web App Built With Simplicity.

Please give this repo a ⭐ it really helps us!

Visit At noteslify.stonecss.com Using v1.3.8-beta ( Latest v1.3.8-beta, Latest Stable v1.4.0 )

Our System Statuspage is Available At dvstechlabs.statuspage.io

Border

Team

The Developer Team behind Noteslify. This project wouldn't have been possible without them and our awesome contributors.

Contributing

Border

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's Code of Conduct.

Monorepo structure

Border

Name Path Description
@noteslify/web /apps/web Web/Desktop/Docker clients
@noteslify/mobile /apps/mobile Android/iOS clients

Deployment

Border

Make Sure You Have MongoDB and NodeJS Installed.

Deploying Backend

To deploy this project navigate to the backend folder and run

  cd apps/web/backend
  npm install
  node index.js

or

  nodemon

Create a .env file in the backend folder and add the following

JWT_SECRET = "RANDOMSTRINGMUSTNOTCHANGE"
clientId = "GITHUBAUTHCLIENTID"
clientSecret = "GITHUBAUTHCLIENTSECRET"
GoogleClientId = "GOOGLEAUTHCLIENTID"
GoogleClientSecret = "GOOGLEAUTHCLIENTSECRET"
SECRET = "RANDOMSTRINGMUSTNOTCHANGE"
DefaultGitHubPassword = "RANDOMSTRINGMUSTNOTCHANGE"
outlookEmail = "OUTLOOKEMAIL"
outlookPassword = "OUTLOOKPASSWORD"

Note : Outlook Email and Password are used for sending Forgot Password emails to users. Github And Google Auth is currently being added to the project therefore they are required as well.

Deploying Frontend

To deploy this project navigate to the frontend folder and run

  cd apps/web/frontend
  npm install
  npm start

Navigate to http://localhost:3000/

Feedback

Border

If you have any feedback, please reach out to us at [email protected]

Stargazers

Border

Our awesome stargazers! Thank you for your support!

Stargazers repo roster for @dvstechlabs/Noteslify

Support

If you would like to support us, you can support on any of the below platforms.

Border