readme.md

Coding Refresher Hub

Table of contents

Introduction

Coding Refresher Hub a project for keeping up with the latest technologies and best practices, in what I consider my main tech stack. Build with React for the frontend and Node.js for the backend.

Features

• Authentication: Users can sign up, log in, and log out.
• Standard E-commerce Shop: Users can browse products, add them to their cart, and checkout.

Getting Started

Prerequisites

Ensure you have the following installed on your system

• LTS version of Node.js: Download and install
• A package manager: npm or yarn or pnpm
• Docker: Docker

Installation

1. Clone the repository

git clone [TODO: Add the repository URL]

2. Navigate to the project directory

cd coding-refresher-hub

3. Install the dependencies

npm install

4. Set up the environment variables

Create a .env file in the root directory of the project based on .env.example file.:

cp .env.example .env

5. Start the development server

npm run dev

Docker

Build and start the Docker image

docker-compose up --build

Project Structure

The project is structured as follows:

coding-refresher-hub/
├── packages/ - Monorepo packages
│   ├── api-server/ - Node.js backend
│   ├── react-frontend/ - React frontend
├── doc/ 
│   ├── adr/ - Architecture Decision Records
├── .env.example - Environment variables example