DEMO: tc-spa-boilerplate.netlify.app
- Install Node.js and NVM
- Clone or this project and ensure all the boilerplate code is committed onto
main - Run
nvm useornvm use <version>(on machines running Windows) - Run
npm i --legacy-peer-deps(will install the dependencies) - Run
npm start(will start the app in http://localhost:3000/) - Commit all your work onto
developmentand deploy that branch
The boilerplate is configured to be deployed to Netlify, but it can also work with Github pages, Vercel, AWS Amplify, etc.
Instructions for a Netlify setup:
- Click on
New site from Git - Select
Githuband the repository where you forked it - Change Publish directory to
build/public - Change the Build command to
CI= npm run build - Deploy site
- You can change the URL name on
Site settings > Change site name
- At some point, if the project becomes a real product, all the files in
/public/static/imgand/public/static/fontsshould be removed and loaded from a CDN - The CDN URL should be specified in
/config/default.json
To upgrade this boilerplate and use the latest configuration and dependencies, please run this command and select SPA when asked:
npx --legacy-peer-deps -p @tablecheck/scripts tablecheck-scripts init
Create an issue in the Github repository
Pull requests for bug fixes and suggestions are welcome. Please do not raise a PR for take-home assignments. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.
SPA Boilerplate is made with ❤️ by TableCheck, the leading restaurant reservation and guest management app maker. If you are a ninja-level 🥷 coder (Javascript / Ruby / Elixir / Python / Go), designer, product manager, data scientist, QA, etc. and are ready to join us in Tokyo, Japan or work remotely, please get in touch at careers@tablecheck.com or careers.tablecheck.com.
SPA Boilerplate is licensed under the MIT license.
Copyright (c) 2022 TableCheck Inc.
Text Fonts from IBM