This Project Contains All The Information About My Journey In My Life.
The file structure of the project is as follows:
Placemento
├── client
│ ├── public
│ └── src
│ ├── api
│ ├── components
│ ├── pages
│ ├── utils
│ ├── App.jsx
│ ├── index.js
│ └── ...
├── server
│ ├── controllers
│ ├── middleware
│ ├── models
│ ├── routes
│ ├── utils
│ ├── index.js
│ └── ...
├── .gitignore
├── package.json
└── ...To get started, follow these instructions to install the project on your local machine.
Make sure you have the following installed on your machine:
- Node.js (v20.0.0 or higher)
- npm (v10.0.0 or higher)
-
Creating your branch:
I. For Organization Members:
- Branch Creation: As an organization member, when working on a new feature or task, you should create a new branch from the "develop" branch.
The branch name should be in the format
feature-where<description>represents a short description of the task or feature you are working on. For example, if you are adding a login feature, the branch name could befeature-login. - Code Implementation: Implement the necessary changes and new features on your created branch. Make sure to adhere to the organization's coding standards and best practices.
- Code Testing: Thoroughly test your changes on the branch to ensure that they work as expected and do not introduce any bugs or issues.
- Code Review: If required by the organization's development process, request a code review from your peers to ensure code quality and adherence to project guidelines.
- Pull Request Creation: Once you are confident that your code is complete and tested, create a pull request to merge your changes from the
feature-*branch into thedevelopbranch. Clearly explain the purpose and scope of the changes in the pull request description.
II. For External Contributors:
-
Forking the Repository: If you are an external contributor, you should fork the repository to your GitHub account. This will create a copy of the repository under your account, which you can use to make changes and submit pull requests.
-
Branch Creation: After forking the repository, create a new branch from the
developbranch. The branch name should be in the formatfeature-where<description>represents a short description of the task or feature you are working on. For example, if you are adding a login feature, the branch name could befeature-login. -
Code Implementation: Implement the necessary changes and new features on your created branch. Make sure to adhere to the organization's coding standards and best practices.
-
Code Testing: Thoroughly test your changes on the branch to ensure that they work as expected and do not introduce any bugs or issues.
-
Code Review: If required by the organization's development process, request a code review from your peers to ensure code quality and adherence to project guidelines.
-
Pull Request Creation: Once you are confident that your code is complete and tested, create a pull request to merge your changes from the
feature-*branch into thedevelopbranch. Clearly explain the purpose and scope of the changes in the pull request description.
- Branch Creation: As an organization member, when working on a new feature or task, you should create a new branch from the "develop" branch.
The branch name should be in the format
-
Clone the repository:
git clone https://github.com/Sagargupta16/My_Journey.git
-
Navigate to the project directory:
cd my_journey -
Install the project dependencies:
npm install npm run fb-install
-
Start the development server:
npm run dev
-
Open the application in your browser:
http://localhost:3000
The application should now be running in your browser.
If you would like to contribute to the project, please read the CONTRIBUTING.md file for more information.
This project is licensed under the MIT License.
If you have any questions or need further assistance, please feel free to contact us.
The project is currently under development. The initial version of the project is expected to be released soon.
The project team consists of the following members: