AuthFlow

A project by Its-me-ak

This project utilizes a modern tech stack to provide a robust authentication flow.

Homepage: https://authflow-wt2e.onrender.com/

🚀 Installation

Follow these steps to get the project up and running on your local machine.

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v18 or higher)
• npm (v6 or higher) or Yarn
• MongoDB

Steps

1. Clone the repository:

   git clone https://github.com/Its-me-ak/AuthFlow.git
   cd AuthFlow

2. Install dependencies:

   • Backend:

     cd backend
     npm install
     cd ..

   • Frontend:

     cd frontend
     npm install
     cd ..

3. Configure environment variables:

   • Create a .env file in the backend directory.

   • Add the following variables, replacing the placeholders with your actual values:

     NODE_ENV=development # or production
     MONGODB_URI=<your_mongodb_connection_string>
     JWT_SECRET=<your_jwt_secret>
     # Add other necessary environment variables
     

4. Run the application:

   • Backend:

     cd backend
     npm run dev # or npm run start for production
     cd ..

   • Frontend:

     cd frontend
     npm start
     cd ..

✨ Key Features

• Secure Authentication: Implements JWT (JSON Web Tokens) for secure user authentication.
• User Management: Provides functionalities for user registration, login, and profile management.
• Modern Tech Stack: Built with Express.js, React, Tailwind CSS, and other modern technologies.
• Database Integration: Uses MongoDB for storing user data and other application data.
• Responsive Design: The frontend is built with Tailwind CSS, ensuring a responsive and user-friendly experience across different devices.
• State Management: Utilizes Zustand for efficient state management in the React frontend.

🤝 Contributing

Contributions are welcome! Here's how you can contribute:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with descriptive commit messages.
4. Push your changes to your fork.
5. Submit a pull request to the main branch of the original repository.

Please ensure your code follows the project's coding style and includes appropriate tests.