Skip to content

thread-rpi/needle-ui

Repository files navigation

threadBranding-WordmarkFinal

Welcome to the Needle frontend repository - this repository contains the UI code for the Needle web app. Read the full documentation here:

Getting Started - Installation

Prerequisites

Before you start, make sure you have the following installed:

  • Node.js (at least version 12.x)
  • npm (usually comes with Node.js)

You can check your Node.js and npm versions by running node -v and npm -v in your terminal.

Cloning the Repository

First, clone the repository to your local machine:

git clone [email protected]:thread-rpi/needle-ui.git
cd your-project-directory

Installing Dependencies

This frontend repo has dependencies that you'll need to install to run properly on your machine:

```bash
npm install
```

Running the Application

To locally run a frontend server, use the command:

npm run dev

This command is configured in the root package.json file. By default, the server runs on localhost:5173.

Exploring the Application

After starting the application, you can access it at http://localhost:5173

Feel free to explore and interact with the React frontend.

Next Steps

Now that your environment is set up, you're ready to start developing! Here are a few suggestions for next steps:

  • Explore the documentation and components for more detailed information on the specifics of the application.
  • Review the existing components and routes to get a feel for the application structure.
  • Begin adding new features or modifying existing ones.

Thank you for contributing to our project! If you encounter any issues, please report them on our issues tracker or directly to ths22115.

About

The frontend repo of Needle, the web platform of the fashion and visual design publication club, The Thread.

Resources

License

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •