Site-Verifier is a web application that allows users to register, login, and validate website contents. It provides a user-friendly interface for managing user accounts, sending website for validation, and viewing previously sent website.
- User registration: Users can create a new account by providing their name, username, email, and password.
- User login/logout: Registered users can log in and out of their accounts securely.
- User profile: Users can view their profile information, including their name, username, and email.
- Site validation: Users can input the Url for validation, and the system will check its contents for validity.
- Node.js: JavaScript runtime environment for server-side development.
- Express.js: Web application framework for building RESTful APIs.
- bcrypt: Library for password hashing and verification.
-
Clone the repository to your local machine.
-
Install Node.js and MySQL if not already installed.
-
Create a new MySQL database.
-
Create a
.env
file in the root directory and add the following variables:DATABASE_URL=your_mysql_database_url
-
Run the following command to install the required dependencies:
npm install
-
Start the server by running the following command:
npm start
-
Access the application by opening
index.html
in theclient
directory in your browser.
- Open the Site-Verifier application in your browser.
- Register a new account by clicking the "Sign Up" button and filling out the registration form.
- Log in to your account by clicking the "Log In" button and entering your email and password.
- View your profile information by clicking the "Profile" button.
- Input URL for validation then click the "Submit" button.
Endpoint | Description |
---|---|
POST /register | Creates a new user account. |
POST /login | Logs in a user and returns a JSON Web Token. |
POST /logout | Logs out a user and destroys their session. |
GET /profile | Retrieves the user's profile information. |
POST /validate | Sends website for validation. |
GET /emails | Retrieves a list of previously sent URL. |
Contributions to the Site-Verifier project are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.
When contributing, please ensure that you follow the existing code style and conventions, write clear commit messages, and provide appropriate documentation for any new features or changes.
The Site-Verifier project is licensed under the MIT License.
Feel free to customize this README.md
file according to
your specific project requirements and add more details as needed.