/yoship_front_deploy

Primary LanguageHTML

YoShip

YoShip is a cool project with a JS back and front app.

This project is for Wild Code School students in Paris and it is made in Javascript (React / NodeJS). It aims to promote a new way of delivery (like Chronopost) but mainly for luxury brands.

Instructions

Project requirements for front app

  • [TO BE REPLACED BY STUDENTS]

Suggested requirements (for Mac)

  • [TO BE REPLACED BY STUDENTS]

Suggested requirements (for Windows)

  • [TO BE REPLACED BY STUDENTS]

Project contents

mockup/
public/
src/
    assets/
    components/
    services/
    tests/
    utils/
*.json
README.md

You can find wireframes into the mockup/ directory to lead you during your development. You have to strictly respect this design and implement each asset file.

Workflow

YoShip works with SCRUM method.

It means that you need to make sprints, SCRUM rituals and so on according to your trainer at the Wild Code School. You have to create a complete Backlog Product dispatched on your Github dashboard with some issues sorted by labels such as feature types, priorities, sprints number, the workflow process...

Before each sprint, you have to organize your issues with weight and priority. You can see that with your "Product Owner" (who is Cedric Hidot, Gaëtan Rolé and other YoShip members).

During each sprint, push on your new branch with clear and english commit messages. When you are ready, write a complete pull request with all your modification int it. This one has to be very clear and detailed. When pull request is okay, you can squash all your commits into one (do not hesitate to fixup some useless messages) and rebase your branch. Do not forget to move your issues (or by commits / PR) on your project dashboard.

At the end of the sprint, you need to present your sprint work to your client with a structured presentation like a Google doc with a summary. Once you sprint is validated, you can share your feedback with your Product Owner and close for good your sprint issues.

SCRUM - Definition of done

Each SCRUM team has its own DoD or acceptance criteria for User Stories. For this project, you have to respect those ones:

  • Documented code (and markdown when it's necessary),
  • Commit for each step of the User Story,
  • Feature done like it has been described,
  • JS Linter,
  • Code merged into develop and then preprod.

Usage

  • 1/ Clone this repository by SSH and run static pages from mockup directory to immerse yourself in the project idea.
  • 2/ Create your new branch with a correct name according to your first issue available on your project dashboard. The branch naming convention is: [branch-type]/[issue-number][sort-issue-title]. According to the Git flow, branch types are usually : feature, hotfix, release... E.g : feature/02-connect-authentification, feature/12-yoship-client-dashboard.

Commands

npm install
Install dependencies.

npm start
Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.

npm test
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed! See the section about deployment for more information.

Installation instructions

[ NEED TO BE REPLACED BY YOURSELF ]

Documentation

Before this development, be sure to be comfortable with your current work environment. Like to setup your IDE, install all necessary plugins, prepare your keyboard shortcuts, create your Bash aliases etc... To follow best practices and good resources you can read :

⬆️ Back to top