Welcome to RESTful-express-react

This web application consists of a RESTful API (Express) and a React app. The front-end is built using React.js, incorporating Redux Toolkit (RTK) and other tools.

Table of Contents

• Features
• Installation
  • Prerequisites
  • Clone the repository
  • Setting up the API (backend)
  • Setting up the React app (frontend)

Features

• RESTful API:

  • User Authentication:

    • Register: POST /user/register
    • Login: POST /user/login
    • Logout: POST /user/logout

  • User Management:

    • Admin Capabilities:
      • View a list of all users: GET /user (admin only)
      • Update user information: PUT /user/:id (admin only)
      • Delete a user: DELETE /user/:id (admin only)
    • Self-Management:
      • View current user details: GET /user
      • Update own profile: PUT /user/profile (Partialy code implemented, not fully functional - test pending)

  • JWT-based Authentication:

    • Access Token:
      • Stored in an HTTP-only cookie.
      • Expires in 3 hours (configurable).
    • Refresh Token:
      • Stored in an HTTP-only cookie.
      • Expires in 24 hours (configurable).

• React App:

  • User Interface:
    • User Registration & Login Form
    • User List (admin only)
    • User Profile (current user only)
    • Admin Actions:
      • Update user information
      • Delete users
  • State Management:
    • Redux Toolkit (RTK)
  • Responsive Design:
    • Mobile-first (mobile-friendly) design
    • Responsive UI layouts

Installation

The installation process is divided into two parts:

• setting up the API (backend - express app)
• setting up the React app.

Prerequisites

• Node.js (v20.10.0 or higher)
• npm

Clone the repository

git clone https://github.com/Esh07/react-redux-auth-w-express.git
cd react-redux-auth-w-express

This command will clone the repository to your local machine. Navigate to the project directory, which contains two subdirectories: backend and frontend-app.

Setting up the API (backend)

Follow the installation instructions from backend/README.md.

Setting up the React app (frontend)

Follow the installation instructions from frontend-app/README.md.