Build setup   |   Changelog   |   Next.js documentation

SkateHub Frontend

The project requires Next.js, Node.js and Backend-GraduateProgram-FullStack-2023 to run locally.

⚙️ Build setup

Welcome! Here's a quick guide to getting started with SkateHub Frontend. Let's dive in:

👣 Step 1: Clone the repository

First things first, let's clone the repository onto your local machine. If you're not sure how to do this, no worries! Here's a simple command you can run in your terminal:

# clone the repository

git clone https://github.com/jpcmf/Frontend-GraduateProgram-FullStack-2024.git

👣 Step 2: Navigate to the project directory

Once the repository is cloned, navigate into the project directory using the cd command in your terminal:

# navigate to the project directory

cd Frontend-GraduateProgram-FullStack-2024

👣 Step 3: Switch to the develop branch

Our development work usually happens in the develop branch. Make sure you're on the right branch by executing the following command:

# switch to the develop branch

git checkout develop

👣 Step 4: Configure environment variables

Before running the project, you'll need to configure the environment variables. This typically involves setting up database credentials and other configurations. Locate the .env.example file in the project root directory, and create a new file named .env with your configurations. You may need to consult the project documentation for the required variables.

# configure environment variables

cp .env.example .env.local

👣 Step 5: Install dependencies

Now that you're in the project directory and on the correct branch, it's time to install all the dependencies. Simply run:

# install dependencies
npm install

👣 Step 6: Run the project

You're almost there! To start the application in development mode, just type the following command:

# run at localhost:3000
npm run dev

And that's it! Your SkateHub Frontend should now be up and running locally on your machine.

📝 Changelog

2024

• 2024-11-19 - Add reCAPTCHA verification to sign-up process #70 (v0.1.25)
• 2024-11-19 - Add Lint-Staged to enhance pre-commit validations #65 (v0.1.24)
• 2024-11-19 - Create an API Route for the Sitemap #62 (v0.1.23)
• 2024-11-13 - Add reCAPTCHA verification to sign-in process #59 (v0.1.22)
• 2024-11-08 - Add Husky #53 (v0.1.21)
• 2024-11-08 - Add vercel development deployment configuration #31 (v0.1.20)
• 2024-11-06 - Add the forgot-password button #25 (v0.1.19)
• 2024-11-06 - Upgrade libraries #23 (v0.1.18)
• 2024-11-06 - Create the reset password page #21 (v0.1.17)
• 2024-04-28 - Update the forgot-password page of the SkateHub project #20 (v0.1.16)
• 2024-04-28 - Redirect to the root route when attempting to access /auth #19 (v0.1.15)
• 2024-04-28 - Create the forgot-password page of the SkateHub project #18 (v0.1.14)
• 2024-04-11 - Update the signin page of the SkateHub project #17 (v0.1.13)
• 2024-04-08 - Create the confirmation page of the SkateHub project #15 (v0.1.12)
• 2024-04-06 - Update the signin page of the SkateHub project #14 (v0.1.11)
• 2024-04-03 - Create the signup page of the SkateHub project #12 (v0.1.10)
• 2024-03-31 - Update authentication and session management #11 (v0.1.9)
• 2024-03-29 - Create the toast component #10 (v0.1.8)
• 2024-03-27 - Add the favicon of the SkateHub project #9 (v0.1.7)
• 2024-03-27 - Add the prettier.config.js file to the project to handle with code formatter #8 (v0.1.6)
• 2024-03-27 - Create the signin page of the SkateHub project #7 (v0.1.5)
• 2024-03-26 - Create the header component #5 (v0.1.4)
• 2024-03-26 - Create the home page of the SkateHub project #4 (v0.1.3)
• 2024-03-26 - Create the sidebar provider and components to handle with the aside menu #3 (v0.1.2)
• 2024-03-24 - Add Chakra UI to handle with the user interface #2 (v0.1.1)
• 2024-03-19 - Add a quick guide to getting started with the application #1 (v0.1.0)

🚀 Next.js documentation

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

---

Made with ♥ in Brazil