Space Board is a tool used to keep a log of the current sprint so team members can make a note of what went well, what didn't, and what actions can be made for future improvements.
It is functional with some bugs.
Whilst Space Board is functional it isn't quite ready for use by other teams as Space Board was initially built as an internal tool meaning the data is currently opinionated towards Space48 teams which will soon be replaced with the functionality to add custom team names (or not use teams at all).
Deployment is through envoyer.
If changes required to new.php after deployment copy new.php to persist/new.php
Envoyer builds the app on the server
- A local environment/server capable of running PHP (Valet+ is recommended due to ease of use)
- Node >= 8.10
- Yarn (although NPM will suffice)
- Clone the repo
- git clone [email protected]:space48/retro.git
- Ensure you can load http://retro.test as this is currently how the backend (PHP) is accessed
- Run
npm install && npm start
- Add comments to one of 3 columns (good, bad, actions) each week
- Ability to navigate week (next and previous weeks)
- Full Screen mode which is useful for presentation on larger screens such as TVs
The frontend has been built with:
- React for managing the UI and state (bootstrapped with Create React App 3)
- React Transition Group for animations
- Axios for AJAX requests (could probably just use fetch)
- Typescript for custom types/interfaces (included with Create React App)
- CSS Modules for scoped CSS (included with Create React App)
- Node environment variables used to update URLs between local and production
When a new comment is posted it is sent to new.php which populates the JSON file and retrieves the updated data, the app state then gets updated with this data and React will re-render.
This project was bootstrapped with Create React App.
In the project directory, you can run:
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.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
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.
Note: this is a one-way operation. Once you eject, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.