Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 1.66 KB

README.md

File metadata and controls

38 lines (28 loc) · 1.66 KB
Raw

AMP Release Calendar

🚧 under construction 🚧

This project is split into two parts: a React client, and an Express and TypeORM server.

To start: cd release-calendar && npm install

To build and run the app for production: npm run start

  • This serves the client and backend on ENV.SERVER_ENDPOINT

To build and serve the client for development: npm run client

  • Make sure to set ENV.NODE_ENV to anything but production
  • This uses webpack dev server for hot reloading
  • This uses React's development build from your local node_modules folder

To build the client for production: npn run client-build-prod

  • Make sure to set ENV.NODE_ENV to production
  • This uses React's production build

To generate test data: npm run setup To build the server: npm run server-build To serve the server: npm run server-serve To build and serve the server: npm run server

To run tests: npm run test To lint: npm run lint

Local development

  1. Install MySQL for a local database. Add ONLY_FULL_GROUP_BY to @@SQL_MODE
  2. Add a .env file to the root directory. See .env.example for the required variables and replace values with your own.
  3. Run npm run server to connect to the database and start the API server.
  4. In a different terminal, run npm run client to start the client.

Deploy to production

  1. Create a tag: git tag deploy-release-calendar-<date> where <date> is in YYMMDDHHmmss. This can be done easily with npm run deploy-tag.
  2. Push the tag to remote: git tag <remote> deploy-release-calendar-<date> where <remote> is [email protected]:ampproject/amp-github-apps.git or an alias, likely upstream