Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jothiprasath0014/secrets-app
The web-app was developed by using node.js, express.js, ejs, and necessary NPM packages. The main concept of Secrets app was configured with security and authentication and Share your secrets anonymously.
https://github.com/jothiprasath0014/secrets-app
css ejs expressjs javascript nodejs postgresql
Last synced: 1 day ago
JSON representation
The web-app was developed by using node.js, express.js, ejs, and necessary NPM packages. The main concept of Secrets app was configured with security and authentication and Share your secrets anonymously.
- Host: GitHub
- URL: https://github.com/jothiprasath0014/secrets-app
- Owner: Jothiprasath0014
- License: mit
- Created: 2024-07-26T13:45:43.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-07-26T15:39:43.000Z (6 months ago)
- Last Synced: 2024-11-19T16:03:21.093Z (about 2 months ago)
- Topics: css, ejs, expressjs, javascript, nodejs, postgresql
- Language: CSS
- Homepage:
- Size: 4.49 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Secrets App Documentation
### Project Overview
Secrets App (Aurora's Secret) is a web application built using ```Node.js```, ```Express.js```, ```EJS```. It allows users to log in locally or through Google Sign-In and provides functionality to view, create, and manage secrets. The application utilizes various NPM packages to handle ```authentication```, ```session management```, and ```database operations```.
### To Install Dependencies
```
npm i
or
npm install
```
## Necessary NPM Packages or Dependencies
* Postgre SQL (Pg) => [pg](https://www.npmjs.com/package/pg)
- PostgreSQL client for Node.js
* EJS (Embedded Javascript => [ejs](https://www.npmjs.com/package/ejs).
- Embedded JavaScript templating engine.
* Express => [express](https://www.npmjs.com/package/express).
- Web framework for Node.js
* Body-parser => [body-parser](https://www.npmjs.com/package/body-parser)
- Middleware to parse incoming request bodies.
* Axios => [axios](https://www.npmjs.com/package/axios)
-Axios is a promise-based HTTP client for Node.js and the browser to make HTTP requests.
* Bcrypt => [bcrypt](https://www.npmjs.com/package/bcrypt)
-Library for hashing passwords.
* Dotenv => [dotenv](https://www.npmjs.com/package/dotenv)
-Loads environment variables from a .env file.
* Express-session => [express-session](https://www.npmjs.com/package/express-session)
-Middleware for session management.
* Passport => [passport](https://www.npmjs.com/package/passport)
- Authentication middleware for Node.js.
* Passport-google-oauth2 => [passport-google-oauth2](https://www.npmjs.com/package/passport-google-oauth2)
-Passport strategy for Google OAuth2 authentication.
* Passport-local => [passport-local](https://www.npmjs.com/package/passport-local)
-Passport strategy for local username and password authentication.
## Features
* ***Local Authentication:*** Users can sign up and log in using a username and password.
* ***Google Authentication:*** Users can sign up and log in using their Google account.
* ***View Random Secrets:*** Users can view a list of random secrets shared by other users.
* ***Create and Manage Secrets:*** Logged-in users can create, view, and delete their own secrets.
### Technologies Used
* **Frontend:** EJS, CSS
* **Backend:** Node.js, Express.js
* **Database:** PostgreSQL
* **NPM Libraries:** body-parser, express, pg, ejs, axios, bcrypt, dotenv, express-session, passport, passport-google-oauth2, passport-local.
* **API:** Open Library API => [API](https://secrets-api.appbrewery.com/)
### Prerequisites
* Node.js (v12.x or higher)
* npm (Node Package Manager)
* Postgre SQL(pgadmin)
* API
### Set up the PostgreSQL database
- Ensure PostgreSQL is installed and running.
- Create a database for the project.
- Set up the database schema.
### GSAP Animations
```GSAP (GreenSock Animation Platform)``` to create animations for various elements on a web page, including the logo, navbar items, title, description, button, image, and different sections of the page.
**Register the ScrollTrigger plugin**
- ScrollTrigger is a plugin for GSAP that allows you to trigger animations based on the user's scroll position. This plugin can create scroll-driven animations, pin elements during scroll, and synchronize animations with the scrollbar.
```
gsap.registerPlugin(ScrollTrigger)
```
### To start the server
```
nodemon server.js
or
node server.js
```
##### Open in Browser
Open your browser and navigate to ```http://localhost:3000``` to view the application.
## Configuration
#### Environment Variables
* **SESSION_SECRET:** A secret key used to sign cookies for session management.
* **GOOGLE_CLIENT_ID:** Your Google OAuth2 Client ID.
* **GOOGLE_CLIENT_SECRET:** Your Google OAuth2 Client Secret.
* **DATABASE_URL:** URL to connect to your PostgreSQL database.
#### Authentication
* **Local Authentication:** Handled using passport-local and bcrypt for hashing passwords.
* **Google Authentication:** Handled using passport-google-oauth2.
#### Database
The application uses PostgreSQL for storing user and secret data. Ensure that the DATABASE_URL in your .env file points to a valid PostgreSQL instance.
## Usage
#### Logging In
* **Local Login:** Navigate to /login and provide your username and password.
* **Google Login:** Click the "Sign in with Google" button on the login page.
#### Viewing Secret
After logging in, you can view random secrets by navigating to the /secrets page.
#### Creating Secrets
* Navigate to the /secrets page.
* Enter your secret in the provided form and submit.
#### Managing Secrets
* **View Your Secrets:** On the /secrets page, you can view the secrets you have created.
* **Delete Your Secrets:** On the /secrets page, you can delete any of your secrets.
## Screenshots
### Home Page
### Hero Section Page
### LogIn and Register Page
### Submit page
### After Submit
### View Random Secrets
## License
This project is licensed under the MIT License - see the [MIT](https://choosealicense.com/licenses/mit/) License file for details.