Skip to content

vasanthv/veenew

Repository files navigation

Veenew

A calm & minimal microblogging website with Markdown support.

Tech stack

  • Node.js + Express
  • EJS templates + Vue (browser-side)
  • MongoDB + Mongoose

Local setup

  1. Install dependencies:
npm install
  1. Copy the environment template and fill values:
cp .env.example .env
  1. Add local host mappings (required for development domain):
sudo nano /etc/hosts

Add:

127.0.0.1 veenew.local
127.0.0.1 www.veenew.local
127.0.0.1 vasanth.veenew.local

Notes:

  • veenew.local matches the local DOMAIN in config.js.
  • You can replace vasanth with any username subdomain you want to test.
  • On Windows, edit C:\Windows\System32\drivers\etc\hosts with the same entries.
  1. Export environment variables (or run through your preferred env loader) and start:
npm start

The app runs on http://localhost:3000 by default. You can also access it via http://veenew.local:3000.

Scripts

  • npm start: start server
  • npm run api-dev: start with CSRF disabled (local API testing only)
  • npm test: lint project

Contributions

Please refer CONTRIBUTIONS.md for more info.

LICENSE

MIT License

About

a calm microblogging for the fediverse

Resources

License

Stars

2 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors