Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mtsfy/linkself
Application to manage multiple links.
https://github.com/mtsfy/linkself
express mongodb reactjs
Last synced: 4 days ago
JSON representation
Application to manage multiple links.
- Host: GitHub
- URL: https://github.com/mtsfy/linkself
- Owner: mtsfy
- Created: 2024-03-06T19:20:59.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-05-12T16:30:22.000Z (8 months ago)
- Last Synced: 2024-05-12T17:36:14.034Z (8 months ago)
- Topics: express, mongodb, reactjs
- Language: TypeScript
- Homepage: https://linkself.at
- Size: 265 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
LinkSelf
## :page_facing_up: Description
LinkSelf is a platform where users can manage multiple links with one link.
## :gear: Tech Stack
- Frontend
- [Next.js 13](https://nextjs.org/)
- [Tailwind CSS](https://tailwindcss.com/)
- [Next Cloudinary](https://next.cloudinary.com/)
- Backend
- [Express.js](https://expressjs.com/)
- [Mongoose](https://mongoosejs.com/)
- [JSON Web Tokens](https://jwt.io/)
- [MongoDB](https://www.mongodb.com/)
## :rocket: Features
- User authentication with JWT.
- User can manage multiple links for their profile.
- Theme customization for the profile page.
- Unique link for each user profile.
- View analytics for the profile.
## :hammer: Local Installation
### Clone the repository
```sh
$ git clone [email protected]:mtsfy/linkself.git
```
### Backend
```sh
$ cd linkself
$ cd backend
$ npm install
```
Setup environment variables for the backend:
- [MongoDB](https://www.mongodb.com/docs/atlas/getting-started/)
```sh
JWT_SECRET_KEY= # YOUR_SECRET_KEY
PORT=8000
ORIGIN=http://localhost:3000
MONGODB_CONNECTION_URL= # YOUR_MONGODB_CONNECTION_URL from MongoDB Atlas
```
Start the backend server:
```sh
$ npm run dev
```
The backend server will start running on `http://localhost:8000`
### Frontend
```sh
$ cd linkself
$ cd frontend
$ npm install
```
Setup environment variables for the frontend:
- [Next Cloudinary](https://next.cloudinary.dev/installation)
```sh
NEXT_PUBLIC_BACKEND_URL=http://localhost:8000/api
NEXT_PUBLIC_FRONT_URL=http://localhost:3000
NEXT_PUBLIC_JWT_SECRET_KEY= # YOUR_SECRET_KEY (same as backend)
NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME= # YOUR_CLOUDINARY_CLOUD_NAME from Next Cloudinary
```
Start the frontend server:
```sh
$ npm run dev
```
The frontend will start running on `http://localhost:3000`