https://github.com/tablecheck/spa-boilerplate

TableCheck's SPA boilerplate for rapid prototyping of demos, tests and experiments
https://github.com/tablecheck/spa-boilerplate

boilerplate emotion react spa tablekit typescript

Last synced: 27 days ago
JSON representation

TableCheck's SPA boilerplate for rapid prototyping of demos, tests and experiments

• Host: GitHub
• URL: https://github.com/tablecheck/spa-boilerplate
• Owner: tablecheck
• License: mit
• Created: 2021-07-01T01:32:32.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-13T14:47:28.000Z (about 2 years ago)
• Last Synced: 2024-11-16T11:07:52.934Z (3 months ago)
• Topics: boilerplate, emotion, react, spa, tablekit, typescript
• Language: TypeScript
• Homepage: https://tc-spa-boilerplate.netlify.app
• Size: 674 KB
• Stars: 0
• Watchers: 11
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Audit: auditjs.json

Awesome Lists containing this project

README

        
# TableCheck's SPA Boilerplate

DEMO: [tc-spa-boilerplate.netlify.app](https://tc-spa-boilerplate.netlify.app)

## Getting started

- Install [Node.js](https://nodejs.org/en/download/) and [NVM](https://github.com/nvm-sh/nvm#installing-and-updating)

- Clone or this project and ensure all the boilerplate code is committed onto `main`

- Run `nvm use` or `nvm use ` (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 `development` and deploy that branch

## Deploy to production

The boilerplate is configured to be deployed to [Netlify](https://netlify.com), but it can also work with Github pages,

Vercel, AWS Amplify, etc.

Instructions for a Netlify setup:

- Click on `New site from Git`

- Select `Github` and 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`

## Caveats

- At some point, if the project becomes a real product, all the files in `/public/static/img` and `/public/static/fonts`

  should be removed and loaded from a CDN

- The CDN URL should be specified in `/config/default.json`

## Upgrade

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`

## Support

Create an issue in the Github repository

## Contributing

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.

## About Us

SPA Boilerplate is made with ❤️ by [TableCheck](https://www.tablecheck.com/en/join/),

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 [[email protected]](mailto:[email protected])

or [careers.tablecheck.com](https://careers.tablecheck.com).

## License

SPA Boilerplate is licensed under the MIT license.

## Copyright

Copyright (c) 2022 TableCheck Inc.

Text Fonts from [IBM](https://github.com/IBM/plex/releases/)