-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This commit adds the initial version of the README file to the BuyIT project repository. The README provides instructions for getting started with the application, as well as information about its development status, building and running the application, and contributing to the project. This information will be helpful for users and developers who want to use or contribute to BuyIT.
- Loading branch information
Showing
1 changed file
with
50 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# Getting Started with BuyIT | ||
BuyIT is a [React](https://react.dev/) application that helps users buy and sell items online. Please note that this project is currently under development and is subject to change frequently. | ||
### Prerequisites | ||
To run BuyIT, you'll need to have Node.js installed on your machine. You can download [Node.js](https://nodejs.org/en/) from the official website. | ||
## Installation | ||
1. Clone the repository to your local machine using the following command: | ||
```bash | ||
git clone https://github.com/Supsource/BuyIT.git | ||
``` | ||
2. Navigate to the project directory using the following command: | ||
```bash | ||
cd BuyIT | ||
``` | ||
3. Install the dependencies by running the following command: | ||
```bash | ||
npm install | ||
``` | ||
## Running the Application | ||
Once you've installed the dependencies, you can run the application using the following command: | ||
```sql | ||
npm start | ||
``` | ||
This will start the development server and open the application in your default browser. You can make changes to the code and the server will automatically reload the application with the updated changes. | ||
## Building the Application | ||
To build the application for production, you can run the following command: | ||
``` | ||
npm run build | ||
``` | ||
This will create a build directory with the optimized production build of the application. | ||
## Contributing | ||
We welcome contributions to BuyIT! If you'd like to contribute, please follow these steps: | ||
1. Fork the repository to your own GitHub account. | ||
2. Clone the forked repository to your local machine. | ||
3. Create a new branch for your changes using a descriptive name. | ||
4. Make your changes to the code. | ||
5. Test your changes to ensure they work as expected. | ||
6. Commit your changes with a descriptive commit message. | ||
7. Push your changes to your forked repository. | ||
8. Create a pull request from your forked repository to the original repository. | ||
|
||
Once we receive your pull request, we'll review your changes and provide feedback if necessary. If your changes are accepted, we'll merge them into the main branch. | ||
## Additional Information | ||
Please note that this project is still under active development and is subject to frequent changes. If you encounter any issues with running or building the application, you can check the project's documentation or raise an issue in the GitHub repository. | ||
|
||
We hope you enjoy using BuyIT! | ||
|
||
|
||
|
||
|
||
|
1e93822
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
buy-it – ./
buy-it-theta.vercel.app
buy-it-supsource.vercel.app
buy-it-git-main-supsource.vercel.app