Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/9gustin/magic-app
Building this app template based on zerotoshipped.com
https://github.com/9gustin/magic-app
Last synced: about 1 month ago
JSON representation
Building this app template based on zerotoshipped.com
- Host: GitHub
- URL: https://github.com/9gustin/magic-app
- Owner: 9gustin
- Created: 2024-02-17T00:59:57.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-03-17T19:19:15.000Z (9 months ago)
- Last Synced: 2024-10-13T16:32:24.797Z (2 months ago)
- Language: TypeScript
- Homepage: https://magic-app.up.railway.app/
- Size: 942 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Magic app 🔮
### Requisites
- Install Node v18
- Install postgresql
If you have docker can create a container with the following command
```BASH
docker run --name magic-db -e POSTGRES_USER=magic -e POSTGRES_PASSWORD=magic -e POSTGRES_DB=magic-db -p 5432:5432 -d postgres
```
And here are you DATABASE_URL `postgresql://magic:magic@localhost:5432/magic-db`
- Install nodemailer
- Create an account on [Resend](https://resend.com/) and get an API key
- Create an account on [Uploadthing](https://uploadthing.com/) and get your credentials
### Getting started
```BASH
git clone [email protected]:9gustin/magic-app.git
```
```BASH
cd magic-app && vi .env.local
```
Add your credentials
```ENV
WEBAPP_URL=http://localhost:3000
DATABASE_URL=postgresql://DB_USER:DB_PASSWORD@localhost:5432/DB_NAME
RESEND_API_KEY=
NODEMAILER_LOCAL_USER=
NODEMAILER_LOCAL_PASS=
UPLOADTHING_SECRET=
UPLOADTHING_APP_ID=
```
and then run
```BASH
npm install && npm run db:migrate
```
And its ready to go ;)
```BASH
npm run dev
```
### Features
- Signup
- Login
- Forgot password (email with resend)
- User email verification (email with resend)
- Public profile (username, name, bio, avatar and cover image)
- Edit user info
-