Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/enansari/basic-authentication-mvc-nodejs
In this project, it is tried to implement the authentication operation using mvc architecture in nodejs.
https://github.com/enansari/basic-authentication-mvc-nodejs
backpack4 javascript mvc nodejs part-college pug
Last synced: 3 months ago
JSON representation
In this project, it is tried to implement the authentication operation using mvc architecture in nodejs.
- Host: GitHub
- URL: https://github.com/enansari/basic-authentication-mvc-nodejs
- Owner: EnAnsari
- License: mit
- Created: 2024-08-05T18:55:38.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-08-05T19:29:38.000Z (5 months ago)
- Last Synced: 2024-10-10T23:01:11.700Z (3 months ago)
- Topics: backpack4, javascript, mvc, nodejs, part-college, pug
- Language: JavaScript
- Homepage:
- Size: 13.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Node.js MVC Authentication Project
This is a Node.js project implementing a [Model-View-Controller (MVC) architecture](https://github.com/EnAnsari/basic-authentication-mvc-nodejs/wiki/MVC-Architecture) with authentication operations. The project uses `Express` for the web framework, `Sequelize` for ORM with `SQLite3` as the database, and `Passport` with `bcryptjs` for authentication.
## Modules Used
- **Express**: Web framework for building the application.
- **Express-Session**: Middleware for session management.
- **Pug**: Templating engine for rendering views.
- **Sequelize**: ORM for database operations.
- **SQLite3**: Database engine.
- **Bcryptjs**: Library for hashing passwords.
- **Passport**: Authentication middleware.
- **Passport-Local**: Passport strategy for username and password authentication.
## Tutorial
This project is based on a tutorial from [LogRocket Blog](https://blog.logrocket.com/).
## License
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.
## Installation
To get started with this project, follow these steps:
1. **Clone the repository:**
```bash
git clone https://github.com/EnAnsari/basic-authentication-mvc-nodejs
```
2. **Navigate to the project directory:**
```bash
cd basic-authentication-mvc-nodejs
```
3. **Install dependencies:**
```bash
npm install
```
4. **Create and configure the database:**
The project uses SQLite3. By default, a database file will be created in the root directory when you run the application.
5. **Create a `.env` file:**
Create a `.env` file in the root directory of your project and add the necessary environment variables. For example:
```env
SESSION_SECRET=your-session-secret
```
Adjust these settings according to your needs.
## Running the Application
To start the application, use the following command:
```bash
npm start
```
By default, the application will run on `http://localhost:8080`.
## Usage
+ **Authentication**: Users can register, log in, and manage their sessions.
+ **[MVC Structure](https://github.com/EnAnsari/basic-authentication-mvc-nodejs/wiki/MVC-Architecture)**: The application follows the MVC architecture.
+ **Model**: Defines the data structure and interacts with the database.
+ **View**: Renders the HTML using Pug templates.
+ **Controller**: Contains the logic for handling user requests and responses.
## Contributing
We welcome contributions to improve the project! If you'd like to contribute, please follow these steps:
1. **Fork the repository** on GitHub.
2. **Clone your fork**:
```bash
git clone https://github.com/EnAnsari/basic-authentication-mvc-nodejs
```
3. **Create a new branch** for your feature or bugfix:
```bash
git checkout -b feature/your-feature
```
4. **Make your changes** and commit them:
```bash
git add .
git commit -m "Add your message here"
```
5. **Push your changes** to your fork:
```bash
git push origin feature/your-feature
```
6. **Submit a Pull Request** on GitHub, describing your changes and any relevant information.
## Contact
For any questions or feedback, please reach out to [[email protected]](mailto:[email protected]).