/bandungdev.com

BandungDev Community Website

Primary LanguageTypeScript

🏯 BandungDev.com

Bandung Developer Community Website

🚧 This web app is still in early and active development

Check out:

Concept

🚧 WIP

This website allow to:

  • Discover community team and members
  • Explore various events

Getting Started

  1. Read about Remix and the Remix Docs to understand about Remix.
  2. If new, focus on Remix basics. Read Super Simple Start to Remix.
  3. If experienced, use various integration such as Prisma ORM and database like MySQL. Read Blog Tutorial (short) and App Tutorial (long).

Tech Stack

  1. TypeScript: Typed language
    • Related to JavaScript, HTML, CSS
  2. React: UI library
  3. Remix: Web framework
  4. Tailwind CSS: Styling
  5. Radix UI: Interactive components
  6. Prisma: Database ORM
  7. PlanetScale: MySQL-compatible serverless database platform
    • MySQL: Database management system
  8. Vercel: App deployment

Setup

Development

Dependencies

Use pnpm to improve productivity and replace npm, so make sure pnpm is installed:

npm i -g pnpm

To run the app locally, make sure the project's local dependencies are installed:

pnpm install

Code

Format, lint, and build to check if the setup is fine:

pnpm check
# run: format lint stylelint build typecheck

pnpm check:fix # to fix most cases if there's an issue
# run: format:fix lint:fix stylelint:fix

Note: Ignore non-critical warning about ESLint and TypeScript

Database

Prisma ORM is used to communicate with the database easily. Since this app is primarily using PlanetScale, the migration files are not needed. Therefore, push the schema directly there, then the migration will be handled through the deploy requests.

Also read:

If prefer using Docker and Docker Compose for local development, follow this guide.

Environment Variables

Create the .env file from the example .env file.

cp -i .env.example .env

This .env file is only for local development, not production

Let's configure the required environment variables in the .env file if local, otherwise in the project settings, for:

  • DATABASE_URL
  • SESSION_SECRET

For the database, either choose to use PlanetScale or local Docker container. If prefer using Docker and Docker Compose for local development, follow this guide.

Create a PlanetScale account to have a MySQL instance for development. After the database has been created, "Get the connection string" and select "Prisma", then copy the full DATABASE_URL.

Keep in mind the free plan only allow for 1 database. So either later keep it, delete it when unused, or upgrade the plan.

Generate a random string for the SESSION_SECRET using openssl rand -base64 32 on the terminal or put any long random text.

DATABASE_URL="mysql://username:password@aws.connect.psdb.cloud/bearmentor?sslaccept=strict"
SESSION_SECRET="random_secret_text"

Schema to Push

Sync between Prisma schema and the database directly, by making schema changes with prisma db push, which can be done regularly while updating the models:

pnpm db:push
# prisma db push

Even with local development without PlanetScale, pushing the schema directly is still okay when prototyping the schema. After a success push, then it will automatically run prisma generate.

Data for Credentials

Create users.json in prisma/seed-data folder with the format below. You can focus on certain users who want to be able to sign in in development, so it doesn't have to be everyone.

[
  {
    "email": "user1@example.com",
    "username": "username",
    "password": "set_the_password_1"
  },
  {
    "email": "user2@example.com",
    "username": "username2"
  }
  // ...
]

Data for Seed

Then seed the initial data when needed:

pnpm db:seed
# prisma db seed

Build

Check if the build is fine:

pnpm build
# remix build

This will also run prisma generate too before the build

Develop Locally

If everything works fine, start the Remix development server like so:

pnpm dev
# remix dev

Open up http://localhost:3000 and it should be ready to go!

Regularly, either push or generate the schema after changing the Prisma schema or database models.

pnpm db:push
# prisma db push

pnpm db:gen
# prisma generate

Checking Dependencies

To keep the dependencies up to date, use taze.

pnpm dlx taze
# or if installed globally
taze

Deployment

This repo has been setup to autodeploy to Vercel automatically on Git push. Can also be deployed to other new projects on Vercel.

After having run the create-remix command and selected "Vercel" as a deployment target, import the Git repository into Vercel.

Cnfigure the required environment variables in project settings for:

  • DATABASE_URL
  • SESSION_SECRET

Then deploy it. There should be the deployed URL like https://bandungdev.vercel.app.

References

Related