Skip to content

Latest commit

 

History

History
83 lines (50 loc) · 4.29 KB

README.md

File metadata and controls

83 lines (50 loc) · 4.29 KB
Raw

Secret Shed

Secret Shed is a minimalistic, scalable blog web app, which can be used to publish blogs written with additional features of markdown. Because of its privacy-related liberations, we keep the user information encrypted.

For privacy policy, visit this link.

  • CRUD: Add, retrieve, update, delete, all according to your needs.
  • Save every bit: A save as pdf feature has been added with the latest release which allows users to save their content as PDFs.

img2

  • Stay anonymous: Nobody gets to know the authors. Everything is encrypted and this is what we get on the backend.
  • Share articles with a public link: After you've done editing your content, you can now share it with a single click. A public link will be created and pasted on clipboard within moments.
  • Encrypted pdfs: The downloaded pdf is anti-OCR, which makes it almost impossible for the text to be copied and pasted.
  • Fast retrieval: Low server latency and hence fast retrieval.
  • Full markdown support: Write and engage in markdown, just like all other blog sharing websites.

img

Installation

Follow the steps to install the application to your local machine:

  • Fork and clone this repository make an instant copy of the content.
  • Alternatively, you can download the source and set it up with Github Desktop.
  • Open the root folder in the code editor you prefer, and run the following commands:
  1. npm install
  2. cd ./frontend/ && npm i
  3. cd.. && npm run dev, already configured in package.json.
  • Set the environment variables from the mongoDB server configurations and configure your own password for verification through the database.
  • The environment variables can be located through CLI installation via NPM.

Common issue faced while installation

''' node:internal/modules/cjs/loader:488 throw e; '''

This could occur due to discrepencies with various versions of Node.

How to fix: Delete the package-lock.json file and reinstall.

Better fix: To containerize the repository with Node environment and pull using Docker.

To-do

  • Make the app responsive.
  • Implement pseudo-fetch algorithm in the getAll() function of this file.
  • Deploy on a better alternative to Heroku.

Documentation

You can find the privacy policy on this page.

Check out the Getting Started page for a quick overview of the project structure.

You can improve it by sending pull requests to this repository.

Contributing

The main purpose of this repository is to continue evolving React core, making it faster and easier to use. Development of React happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving React.

Code of Conduct

Secret Shed has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing Guide

Read the React's contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to React, or overall MERN.

Good First Issues

To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started <3.

License

MIT.