LaMia/notely
Watch
1
0
Fork
You've already forked notely
 0
mirror of https://github.com/LaMia-3/notely.git synced 2026-10-13 20:31:53 -04:00
Code Issues Projects Releases Packages Wiki Activity
No description https://notely-nine-beta.vercel.app
76 commits 2 branches 0 tags 796 KiB
  • JavaScript 99.4%
  • CSS 0.4%
  • Shell 0.1%
Find a file
Exact
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Mia 2dd5dd2f3f
 Merge pull request #9 from LaMia-3/the-first-commit 
The first commit
2026-03-20 18:06:39 -04:00
docs Improve mobile search and refresh project docs 2026-03-20 12:31:29 -04:00
entitites Add project configuration and entity schemas 2026-02-07 19:51:55 -05:00
public Add PWA manifest and placeholder icon files for progressive web app support 2026-02-16 14:42:15 -05:00
server Add automated server and client test coverage 2026-03-20 01:49:50 -04:00
src Add group album and member filters 2026-03-20 13:27:55 -04:00
.gitignore Added all stores to git ignore. 2026-02-16 15:35:26 -05:00
components.json Add project configuration and entity schemas 2026-02-07 19:51:55 -05:00
enlist.config.js Add project configuration and entity schemas 2026-02-07 19:51:55 -05:00
index.html Add authentication middleware, Mongoose models, and API routes 2026-02-08 13:00:50 -05:00
jsconfig.json Add authentication middleware, Mongoose models, and API routes 2026-02-08 13:00:50 -05:00
package-lock.json Add automated server and client test coverage 2026-03-20 01:49:50 -04:00
package.json Add automated server and client test coverage 2026-03-20 01:49:50 -04:00
postcss.config.js Add project configuration and entity schemas 2026-02-07 19:51:55 -05:00
README.md Improve mobile responsiveness across app 2026-03-20 12:53:02 -04:00
start-local.sh Refactor backend structure and tighten API validation 2026-03-19 17:03:41 -04:00
tailwind.config.js Add project configuration and entity schemas 2026-02-07 19:51:55 -05:00
vercel.json Add comprehensive error handling, validation, and logging to AlbumDetail page with automatic redirect for missing album ID 2026-02-16 18:41:10 -05:00
vite.config.js Add automated server and client test coverage 2026-03-20 01:49:50 -04:00

README.md

Notely

Notely app screenshot

Notely is a group album review app for people who want more structure than a chat thread and less friction than a spreadsheet. It gives music groups a shared queue, a live review cycle, track-by-track reactions, top-track picks, and a compare view once everyone has submitted.

Checkout the live app: notely-nine-beta.vercel.app

What the app does

  • Create private groups for album review with friends
  • Queue albums and control what comes next with voting, queue order, or owner selection
  • Mark one album as active for the current review cycle
  • Write review notes, score albums, add track notes, and choose top track picks
  • Unlock a compare view after the full group has submitted
  • Notify users when a new album is ready and when compare is available
  • Manage users and system announcements through the admin flow

Tech stack

  • Frontend: React, Vite, React Router, TanStack Query, Tailwind CSS, Radix UI
  • Backend: Express, MongoDB, Mongoose, JWT authentication
  • Tooling: Vitest, Node test runner, Vercel deployment entrypoint

Getting started

Requirements

  • Node.js 18+
  • npm
  • A MongoDB database

Environment variables

Create a .env file in the project root with the values your environment needs:

MONGODB_URI=mongodb://127.0.0.1:27017/notely
JWT_SECRET=replace_me
JWT_EXPIRES_IN=7d
ADMIN_EMAIL=admin@example.com
ADMIN_PASSWORD=replace_me
VITE_API_URL=http://localhost:3001/api

Notes:

  • MONGODB_URI is required for the backend.
  • JWT_SECRET falls back to a local development value if missing, which is not appropriate outside local work.
  • ADMIN_EMAIL and ADMIN_PASSWORD bootstrap the configured admin login.
  • VITE_API_URL points the frontend at the API during local development.

Install and run

npm install
npm start

In a second terminal, start the frontend:

npm run dev
  • Frontend: http://localhost:5173
  • API: http://localhost:3001/api

Testing

npm test

Builds are gated by both test suites:

npm run build

Project status

Notely is an actively evolving hobby project focused on album clubs, group listening, and shared review workflows.