Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/customcraft-software-llc/website-saver
Saves website links online cloud
https://github.com/customcraft-software-llc/website-saver
Last synced: 8 days ago
JSON representation
Saves website links online cloud
- Host: GitHub
- URL: https://github.com/customcraft-software-llc/website-saver
- Owner: CustomCraft-Software-LLC
- License: other
- Created: 2025-01-02T18:16:32.000Z (28 days ago)
- Default Branch: main
- Last Pushed: 2025-01-21T01:28:27.000Z (10 days ago)
- Last Synced: 2025-01-21T02:24:44.095Z (10 days ago)
- Language: JavaScript
- Size: 66.2 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LinkSaver
Saves website links online database
## Structure
.
├── client-link-saver
│ ├── dist
│ │ ├── assets
│ │ │ └── index-C9KQqcdL.js
│ │ └── index.html
│ ├── eslint.config.js
│ ├── index.html
│ ├── package.json
│ ├── package-lock.json
│ ├── public
│ ├── README.md
│ ├── src
│ │ ├── App.jsx
│ │ ├── assets
│ │ │ └── theme.js
│ │ ├── components
│ │ │ ├── HomeLoggedIn.jsx
│ │ │ ├── HomeLoggedOut.jsx
│ │ │ ├── LinksList.jsx
│ │ │ ├── LoginButton.jsx
│ │ │ ├── LogoutButton.jsx
│ │ │ └── Navbar.jsx
│ │ ├── contexts
│ │ │ └── Auth0.jsx
│ │ ├── hooks
│ │ ├── index.css
│ │ ├── main.jsx
│ │ ├── pages
│ │ │ ├── DashboardPage.jsx
│ │ │ └── HomePage.jsx
│ │ └── services
│ │ └── linksService.js
│ ├── structure.txt
│ └── vite.config.js
├── README.md
├── server-link-saver
│ ├── config
│ │ └── config.json
│ ├── controllers
│ │ ├── linkController.js
│ │ └── linkControllerList.js
│ ├── index.js
│ ├── middleware
│ │ └── authMiddleware.js
│ ├── migrations
│ │ └── 20250104215046-create-links.js
│ ├── models
│ │ ├── index.js
│ │ └── Link.js
│ ├── package.json
│ ├── package-lock.json
│ ├── README.md
│ ├── routes
│ │ └── index.js
│ ├── seeders
│ ├── structure.txt
│ ├── tests
│ │ └── LinkTest.js
│ └── utils
│ └── validateData.js
└── structure.txt
21 directories, 40 files
## Configuration
### 1. Overview
This is a full-stack link saver application that allows users to store, manage, and retrieve links. The app utilizes:
React for the front-end.
Node.js/Express for the back-end API.
PostgreSQL as the database (hosted on Render).
Auth0 for user authentication.
### 2. Setup Instructions
#### 2.1 Prerequisites
Ensure the following are installed on your system:
Node.js (LTS version recommended)
npm or yarn
Git
A Render account for hosting the PostgreSQL database
An Auth0 account for authentication
#### 2.2 Download the Project
Download the ZIP file from the provided link or repository.
Extract the ZIP file to your desired directory.
#### 2.3 Setting Up Auth0
Log in to your Auth0 account.
Create a new Application:
Application Type: Single Page Application.
Add the callback URL: http://localhost:5173 or your deployed client URL.
Add the logout URL: http://localhost:5173 or your deployed client URL.
Create a new API:
Name: Link Saver API.
Identifier: https://link-saver-api ( can be anything ) or your custom API URL.
Select the signing algorithm: RS256.
Retrieve the following details from the Auth0 dashboard:
Domain
Client ID
Client Secret
API Identifier
#### 2.4 Setting Up the PostgreSQL Database on Render
Log in to your Render account.
Navigate to Databases and click Create a New Database.
Configure the database:
Database type: PostgreSQL.
Name: link-saver-db.
Region: Select a region near your server deployment.
Type: Free
Save the connection string provided this should be external link
(e.g., postgres://:@:/).
#### 2.5 Configure Environment Variables
Server-Side: server-link-saver/.env
Create a .env file in the server-link-saver directory:
```bash
PORT=5000
DATABASE_URL=
AUTH0_DOMAIN=
AUTH0_AUDIENCE=
AUTH0_CLIENT_ID=
AUTH0_CLIENT_SECRET=
```
Client-Side: client-link-saver/.env
Create a .env file in the client-link-saver directory:
```bash
VITE_AUTH0_DOMAIN=
VITE_AUTH0_CLIENT_ID=
VITE_AUTH0_AUDIENCE=
VITE_BACKEND_URL=http://localhost:5000/api
```
#### 2.6 Install Dependencies
##### Client
```bash
cd client-link-saver
npm install
```
##### Server
```bash
cd server-link-saver
npm install
```
#### 2.7 Migrate
Run the following commands in the server-link-saver directory:
```bash
npx sequelize-cli db:migrate
```
#### 2.8 Start the Application
##### Server
```bash
cd server-link-saver
npm start
```
##### Client
```bash
cd client-link-saver
npm run dev
```
### 3. Tech Stack
#### Client:
React
Vite
#### Server:
Node.js
Express
Sequelize (ORM)
#### Database:
PostgreSQL (hosted on Render)
#### Authentication:
Auth0