Welcome to the Next.js Fitteia 2.0 project! This README will guide you through the steps to run the project locally on your machine.
Before you begin, ensure you have the following installed on your system:
-
Clone the Repository:
Clone the repository to your local machine using the following command:
git clone https://github.com/mboliveira2003/nextjs_fitteia2.0.git
-
Navigate to the Project Directory:
Change to the project directory:
cd nextjs_fitteia2.0
-
Install Dependencies:
Install the required dependencies using npm:
npm install
Alternatively, if you prefer using Yarn, you can install dependencies with:
yarn install
-
Start the Development Server:
Start the local development server by running:
npm run dev
or if using Yarn:
yarn dev
-
Access the Application:
Open your browser and navigate to https://localhost:3000 to view the application.
A quick overview of the project structure:
nextjs_fitteia2.0/
├── components/ # Reusable components
├── pages/ # Pages of the application
│ └── api/ # API routes
├── public/ # Static files
├── styles/ # Global and component-specific styles
├── .gitignore # Files to ignore in version control
├── package.json # Project metadata and scripts
├── README.md # Project documentation
└── next.config.js # Next.js configuration
In the project directory, you can run the following scripts:
npm run dev
- Runs the app in development mode.npm run build
- Builds the app for production.npm run start
- Starts the production server.npm run lint
- Lints the project for potential issues.
We welcome contributions to this project! To contribute:
- Fork the repository.
- Create a new branch with your feature or bug fix.
- Commit your changes and push the branch to your fork.
- Open a Pull Request to the main repository.
Please ensure that your code follows the project's style guidelines and includes relevant tests.