React JS

Next 15 | Typescript | Tailwind | Google Fonts

Getting Started 🚀

Follow these instructions to clone this repository to your local machine and start working with React JS, Next, Tailwind, and Google Fonts from the beginning.

Prerequisites 📋

To clone this repository, you need to have Node.js and a package manager like NPM or Yarn installed.

Before you start, check if you have Node.js installed by running any of the following commands in your terminal:

node --version
node -v

If you don't have it installed, you can follow the official documentation to install it here:
https://nodejs.org/en/

I always recommend installing the LTS version.

Check the versions of the package managers with:

npm --version
yarn -v

Minimum Versions:

• Node.js: 18.0.0
• NPM: 9.0.0
• Yarn: 3.0.0

Installation 🔧

Without Docker

Clone the repository:

git clone https://github.com/jorgehernandezch/reactjs-next-typescript-tailwind.git

Install all the project dependencies:

npm install

Start the project:

npm run dev

If everything is correct, you can access the project at http://localhost:3000/

With Docker 🐳

1. Build the Docker image:

docker build -t my-next-app .

2. Run the container:

docker run -p 3000:3000 --name my-next-app my-next-app

This will start the application, and you can access it at http://localhost:3000/

3. Access the container's terminal:

docker exec -it my-next-app sh

4. Stop and remove the container:

To stop the container:

docker stop my-next-app

To remove the container:

docker rm my-next-app

5. Using Docker Compose (optional)

If you prefer using docker-compose, use the following steps to set up and run the app:

• Create a docker-compose.yml file with the following content:

version: '3'
services:
  next-app:
    build: .
    ports:
      - "3000:3000"
    volumes:
      - .:/app
      - /app/node_modules  # Mount node_modules inside the container
    environment:
      - NODE_ENV=development
    command: npm run dev
    working_dir: /app

• Build and start the service:

docker-compose up --build

This will start the application, and you can access it at http://localhost:3000/

Collaboration 🤝

Fork the project and create a Pull Request to the Dev branch. Pull Requests to the Master branch will be closed.

Jorge Edo. Hernández
Engineer and Web Developer