Brilliant mentoring
🚧 This app is still in early and active development
The open mentoring platform for people and organization. Open source, free to use, with premium options. 🐻 Bearmentor is a place for tech and creating professionals to mentor each others.
Check out:
- Web: https://bearmentor.com
- Repo: https://github.com/bearmentor
- Progress: https://github.com/orgs/bearmentor/projects/2
men·tor·ship (noun): the guidance provided by a mentor, especially an experienced person in a company or educational institution.
A true mentorship should enable to teach, guide, and share that can be for long term growth.
🐻 Bearmentor allow to:
- Discover people, respective mentors and mentees
- Link social profiles, portfolios, projects, products for credibility
- Explore various learning programs or services by the mentors
- Filter out for serious commitment through initial discussion
- Set custom mentorship experience and achievable goals
- Get paid to mentor people with self-compensation rate, public or private
- Prefer between live/sync or recorded/async communication
- Long term tracking for mentor-mentee relation
- Read the Remix Docs to understand about Remix.
- If new, focus on Remix basics, don't use the Stacks yet. Read Super Simple Start to Remix.
- If experienced, use various integration such as Prisma ORM and database like MySQL. Read Blog Tutorial (short) and App Tutorial (long).
- TypeScript: Typed language
- Related to JavaScript, HTML, CSS
- React: UI library
- Remix: Web framework
- Tailwind CSS: Styling
- Radix UI: Interactive components
- shadcn UI: Styled interactive components
- Tabler Icons: Icon set
- Prisma: Database ORM
- PlanetScale: MySQL-compatible serverless database
platform
- MySQL: Database management system
- Vercel: App deployment
Create the .env file from the example .env file.
cp -i .env.example .envThis .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_URLSESSION_SECRET
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:[email protected]/bearmentor?sslaccept=strict"
SESSION_SECRET="random_secret_text"When using VS Code, there are several recommended extensions that can be
installed to improve the workflow. It's nice to accept the recommendations that
listed in .vscode/extensions.json.
Especially (in alphabetical order):
- ESLint
- Inline Fold for CSS
- Markdown All in One
- Prettier
- Prisma
- Remix Forge
- Stylelint
- Tailwind CSS
Use pnpm to improve productivity and replace npm, so make sure pnpm is installed:
npm i -g pnpmTo run the app locally, make sure the project's local dependencies are installed:
pnpm installFormat, 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:fixNote: Ignore non-critical warning about ESLint and TypeScript
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.
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 pushEven with local development without PlanetScale, this is still okay when
prototyping the schema.
After a success push, then it will automatically run prisma generate.
Create [users-credentials.json] in app/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. For example, only create for
admin, test, or yourname which also available in
app/data/users.ts
[
{
"username": "username",
"email": "[email protected]",
"password": "set_the_password_1"
},
{
"username": "username2",
"email": "[email protected]",
"password": "set_the_password_2"
}
// ...
]Then seed the initial data when needed:
pnpm db:seed
# prisma db seedCheck if the data is fine:
pnpm db:check
# tsx prisma/check.tsCheck if the build is fine:
pnpm build
# remix buildThis will also run
prisma generatetoo before the build
If everything works fine, start the Remix development server like so:
pnpm dev
# remix devOpen up http://localhost:3000 and it should be ready to go!
The vercel dev command provided by Vercel CLI can
also be used when necessary.
Regularly, either push or generate the schema when changing the database fields.
pnpm db:push
# prisma db push
pnpm db:gen
# prisma generateTo keep the dependencies fresh, use taze.
pnpm dlx tazeThis 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_URLSESSION_SECRET
Then deploy it. There should be the deployed URL like https://bearmentor.vercel.app.
- 🐱 Catamyst ⭐
- 🦌 Antelapp ⭐
