Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Nym-HQ/nym
An open-source personal website infrastructure for developers
https://github.com/Nym-HQ/nym
nextjs personal-site personal-website portfolio-page reactjs resume-website tailwindcss
Last synced: 3 months ago
JSON representation
An open-source personal website infrastructure for developers
- Host: GitHub
- URL: https://github.com/Nym-HQ/nym
- Owner: Nym-HQ
- License: mit
- Created: 2022-11-10T16:42:20.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-20T09:34:37.000Z (8 months ago)
- Last Synced: 2024-06-30T15:49:43.059Z (4 months ago)
- Topics: nextjs, personal-site, personal-website, portfolio-page, reactjs, resume-website, tailwindcss
- Language: TypeScript
- Homepage: https://nymhq.com
- Size: 3.1 MB
- Stars: 62
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Nym
An open source solution for personal blogs, bookmarks, newsletters & notes.
## App Domain structure
The system will consist of 3 different apps hosted separately.
### Main app/admin site (e.g: https://app.nymhq.com)
Administrative app to manage your admin account and registered sites.
### Site setup & Mult-tenant (https://{user-subdomain}.nymhq.com or any parked domain)
Same app as the main app site, but the visible content will be different.
This is for registered users and sites to show contents and manage contents.
## Developer Notes
### Environment values (.env)
- `NODE_ENV` (production|development)
- `VERCEL_ENV` (production|preview|development) Set automatically
- `NEXT_PUBLIC_VERCEL_ENV` (production|preview|development) Set automatically
- `VERCEL_URL` (https://{nym-xyz}.vercel.app) Set automatically
- `NEXT_PUBLIC_VERCEL_URL` (https://{nym-xyz}.vercel.app) Set automatically
- `PUBLIC_URL` (https://nymhq.com)
- `VERCEL_TEAM_ID` Vercel Team ID
- `VERCEL_PROJECT_ID` Vercel Project ID
- `VERCEL_API_TOKEN` (https://vercel.com/docs/rest-api#introduction/api-basics/authentication) Token to access Vercel's API
#### Prisma and PlanetScale
A good resource to understand Prisma and its Shadow DB
https://www.prisma.io/docs/concepts/components/prisma-migrate/shadow-database
https://blog.tericcabrel.com/understand-the-shadow-database-feature-prisma/
- `DATABASE_URL` (mysql://user:password@host:port/database)
- `SHADOW_DATABASE_URL` (Only required for local env where we run migration commands)
#### NextAuth.js
- `NEXTAUTH_URL` (https://nymhq.com)
- `NEXTAUTH_SECRET`
- `JWT_SIGNING_KEY`
- `GITHUB_ID`
- `GITHUB_SECRET`
- `TWITTER_API_KEY` Use Twitter API Key
- `TWITTER_API_SECRET` Use Twitter API Secret
#### [Cloudinary](https://cloudinary.com/)
- `CLOUDINARY_CLOUD_NAME` - Cloudinary Cloud name
- `CLOUDINARY_API_KEY` - Cloudinary API KEY
- `CLOUDINARY_API_SECRET` - Cloudinary API Secret
- `CLOUDINARY_PRESET` - Preset name created on Cloudinary, make sure you set the "Signed" property to true
#### [IFramely](https://iframely.com/)
- `IFRAMELY_API_KEY` - Iframely API key - to extract metadata from a url
#### Configurations for Chat Bot
- `OPENAI_API_KEY`
- `PINECONE_ENVIRONMENT`
- `PINECONE_API_KEY`
### Setting up DB for development environment
#### Using PlanetScale
1. Login to https://app.planetscale.com/
2. Create a DB.
3. Copy the connection string for the DB, and set it to the .env file variables. ([See PlanetScale Doc](https://planetscale.com/docs/concepts/connection-strings))
4. Run migration `yarn prisma migrate dev`
### Migrating DB (PScale and Prisma)
#### During Development
1. Edit `prisma/schema.prisma`
2. Format the schema doc
```sh
yarn prisma format
```
3. Migrate dev db
```sh
# Check the changes in the current schema (prisma/schema.prisma)
# and generate migration file, push to DB.
yarn prisma migrate dev
```
#### For Production Deployment
- On PlanetScale, Configure `main` branch as a production branch
- Create a `dev` branch from `main` branch
- Make sure you connect to the `dev` branch only, not to the `main` branch directly.
- When you want to deploy changes from `dev` to `main`, go to https://app.planetscale.com/sov-ventures/nymhq/deploy-requests and create deployment request from `dev` branch to `main` branch.
### Nym is a fork of the briOS project
https://github.com/brianlovin/briOS