Skip to content

PerretWilliam/novelys

Repository files navigation

Novelys

Collaborative reading and writing platform

Node.js pnpm React Native Docker Express License


Overview

Novelys is a mobile platform for collaborative reading and writing. This repository is a monorepo that holds all project packages — a Dockerized Express backend, a React Native mobile app, and a shared library.

Project Structure

novelys/
├── apps/
│   └── mobile/          # Mobile application (Expo / React Native)
├── services/
│   └── api/             # REST API (Express + SQLite, Docker)
└── packages/
    └── shared/          # Shared TypeScript contracts and utilities

Prerequisites

Tool Minimum version
Node.js 22+
pnpm 10+
Docker latest

Installation

Clone the repository and install dependencies from the monorepo root:

git clone https://github.com/your-org/novelys.git
cd novelys
pnpm install

Development

Start the backend and the mobile app in two separate terminals:

# Terminal 1 — API (runs inside Docker)
pnpm dev:api

# Terminal 2 — Mobile app
pnpm dev:mobile

Database

Initialize and seed the SQLite database:

# Apply migrations
pnpm db:migrate

# Inject test data
pnpm db:seed

Packages

services/api

REST API built with Express and SQLite, containerized with Docker. Exposes the endpoints consumed by the mobile application.

apps/mobile

Mobile application built with Expo and React Native. Supports both iOS and Android.

packages/shared

Internal library containing shared TypeScript types, validation schemas, and utilities used across the backend and the mobile app.

Contributing

  1. Branch off main: git checkout -b feat/my-feature
  2. Commit your changes: git commit -m "feat: description"
  3. Open a Pull Request

Commit messages follow the Conventional Commits convention.

Author

Made by William Perret

Website · GitHub · LinkedIn · Instagram · Buy Me a Coffee


License

MIT

About

Novelys is a mobile platform for collaborative reading and writing. This repository is a monorepo that holds all project packages — a Dockerized Express backend, a React Native mobile app, and a shared library.

Resources

License

Stars

Watchers

Forks

Contributors