Skip to content

hadi-alhadi/authentication-client-react

Repository files navigation

Authentication Client React

This project is a React-based authentication client that demonstrates user authentication features, including sign-in, sign-up, and user profile management. It's built with React and integrates with Redux for state management, showcasing best practices in modern web application development.

Features

  • User Sign-in and Sign-up
  • User Profile Management
  • Redux for state management
  • React Router for navigation
  • Formik and Yup for form handling and validation
  • Styled Components for styling
  • React Bootstrap for UI components

Getting Started

Clone the repository to your local machine:

git clone https://github.com/hadi-alhadi/authentication-client-react.git
cd authentication-client-react

Install the necessary dependencies:

npm install

Running the Application

To start the application in development mode, run:

npm start

This will launch the application on http://localhost:3000, where you can navigate through the authentication flow.

Testing

Run the following command to execute the tests:

npm test

Building for Production

To build the application for production, use:

npm run build

This creates a build directory with a production build of the app.

Docker Support

A Dockerfile is included for containerizing the application. Build the Docker image using:

docker build -t authentication-client-react .

Then, run your container:

docker run -p 3000:3000 authentication-client-react

Continuous Integration

The project is configured with GitHub Actions for continuous integration, automatically running lint checks and tests on each push or pull request to the master branch.

Contributing

Contributions to the project are welcome. Please ensure to follow the existing coding style, write tests for your changes, and document any new functionality.

License

Distributed under the MIT License. See LICENSE for more information. This README provides a comprehensive overview of the project, including how to get started, run the application, and contribute. You can copy this content to the README.md file in your repository to update it manually.

About

A React-based authentication solution showcasing sign-in, sign-up, profile management with Redux, React Router, Formik, Yup, and styled components.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors