Yours Sincerely
π Website | App Store | Play Store
An ephemeral anonymous blog to send each other tiny beautiful letters. Write as if your arms are wide open, and hold them far apart.
Get Started
The application follows a typical Remix folder structure. You can find the entry point the web application in the app
directory.
You'll notice that the Remix routes are just thin wrappers and most of the heavy lifting code is done in the /lib
directory. This follows more of a nx/flutter folder structure which helps compartmentalize feature specific code and encourages sharing business logic code between the frontend web and server.
The native code is a capacitor wrapper which can be found in the ios
and android
directories.
βββ /api # Remix server
βββ /app # Frontend client
| βββ /lib # Feature source code (most of the logic lives here)
| βββ /routes # Remix file sytem routes
βββ /ios # iOS webview wrapper
βββ /android # Android webview wrapper
βββ /prisma # Prisma schema and database associated files
βββ /public # Static assets
βββ /styles # Global styles
Install dependencies
- Node.js - LTS version recommended
Local Development
# Rename .env.example to .env and update variables
mv .env.example .env
# Installing dependencies
npm install
# To start the app
npm run dev
# To run native apps (make sure web server is running with the command above)
npm run native-dev-ios
npm run native-dev-android
This will start the Remix development server. When the above command completes you'll be able to view your website at http://localhost:3000
Stack
This project uses the following libraries and services: