Git Product home page Git Product logo

privnote's Introduction

PrivNote v.2

Overview

PrivNote v.2 is a free service that lets you send secret messages.

Key Directories and Files

  • src/app/: Application pages.
  • src/features/: Stores different features used in the app.
  • src/server/: Holds the server-side code.
  • src/server/db/: Contains database related files, including migrations.
  • src/utils/: Utilities used in the application.
  • src/components/: Stores reusable React components.
  • src/lib/: Contains library functions.
  • public/: Stores static files like images.
  • .env: Environment variables file.

Prerequisites

  • Node.js (v16 or later)
  • Docker

Installation

  1. Clone the repository: git clone https://github.com/gashon/privnote
  2. Move into the directory: cd privnote
  3. Install dependencies: pnpm install (or npm install if you prefer)

Running the Application Locally

  1. Create a .env file and fill it with the necessary environment variables based on the .env.example file.
  2. Start docker
  3. Run the app in the development mode: pnpm run dev
  4. Open http://localhost:3000 to view it in the browser.

Building for Production

  1. Build the app for production: pnpm run build
  2. Start the server: pnpm run start

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

privnote's People

Contributors

gashon avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.