✨ About
- Open-Source. the project is fully open source, both backend and frontend.
- Free. you can create a diary for free and without registration.
- Anonymous. it is completely anonymous, you just have to remember your diary code.
Simply Diary is an open source platform to write online diary. Each diary has its own short code making it easily idenfiable for collaborators and diary contributors. Simply Diary is completely free and works without registration, just remember your diary identification codes.
? Self-Hosted
If you want to host a Simply Diary yourself then you have to clone the two repositories first, the backend and the frontend.
Frontend: git clone https://github.com/cnrycodes/simply-diary.git
Backend: git clone https://github.com/cnrycodes/simply-diary-server.git
First we start the backend, navigate to your folder:
$ npm install
$ npm start
The backend should now start on port 8080 if the port has not been changed.
Now we start the frontend, navigate to your folder:
# install dependencies
$ npm install
# serve with hot reload at localhost:3000
$ npm run dev
# build for production and launch server
$ npm run build
$ npm run start
⚠️ Don’t forget to change the API Urls in the Frontend Source Code ⚠️
? Contribute
Introduction
- This site is built with Nuxt.js and TailwindCSS
Feature request or see a bug?
Create a new issue to allow us and other users to discuss the proposed change and work on implementing it.
How to contribute?
- Comment on the issue you are planning to resolve
- Fork the repository
- Fix the problems the issue creator was facing. Open a pull request and tag the issue in your pull request/commits in the pull request
- Your PR will be reviewed, and once it’s approved it will be merged into
main
