https://github.com/extrawest/react_spacelaunch_app
https://github.com/extrawest/react_spacelaunch_app
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/extrawest/react_spacelaunch_app
- Owner: extrawest
- Created: 2022-10-30T13:31:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-30T13:33:00.000Z (over 3 years ago)
- Last Synced: 2025-03-30T17:46:38.529Z (about 1 year ago)
- Language: TypeScript
- Size: 13.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Spacelaunch App
This project was generated using [Nx](https://nx.dev).
Nx supports many plugins which add capabilities for developing different types of applications and different tools.
These capabilities include generating applications, libraries, etc as well as the devtools to test, and build projects as well.
### Deployed Project
Live: [budget-tracker-3da85.web.app](https://spacelaunch-9d930.web.app/)
### Documentation
Here is a short description of all main scripts, commands, and other things that will allow you to start developing this project
#### How to set up your Local Environment?
To start project development you need to have correct node and npm versions. The correct version of the node is in the .nvmrc file. To use it you must, to have nvm(node version manager) installed [(installation guide)](https://github.com/nvm-sh/nvm#installing-and-updating). When you have it installed you can use `nvm use` command from the project root, and it will use version from .nvmrc
```bash
# Use node version specified in .nvmrc
nvm use
# Show current node version
nvm current
```
If you want to update node version you have to do it in .nvmrc
#### How to write correct and meaningful commit messages?
Everyone should write good commit messages, to be able in the future understands what and when was created
Specification: [www.conventionalcommits.org](https://www.conventionalcommits.org/en/v1.0.0/)
Message rules for this project: [conventional-changelog/commitlint](https://github.com/conventional-changelog/commitlint#what-is-commitlint)
#### Project Scripts (from package.json)
```bash
# Start development server for default app
yarn start
# Build default app for production
yarn build
# Create service-worker.js for client app (automatically run after build)
yarn postbuild
# Run unit tests for default app
yarn test
# Lint code for default app
yarn lint
# Run end-to-end tests for default app
yarn e2e
# Run unit tests for all apps and libs
yarn test:all
# Lint code for all apps and libs
yarn lint:all
# Update all Nx plugins and generate migrations.json file
yarn migrate
# Run migrations.json to tweak your code
yarn migrations:run
# Build and deploy client app to live
yarn deploy:client:live
```
#### Nx CLI Cheat Sheet
```bash
# Generate an application
nx g @nrwl/react:app
# Generate a library
nx g @nrwl/react:lib
# Start dev server
nx serve
# Generate a new component
nx g @nrwl/react:component --project=
# Build a project
nx build
# Execute the unit tests via Jest
nx test
# Execute the unit tests affected by a change
nx affected:test
# Execute the end-to-end tests via Cypress
nx e2e
# Execute the end-to-end tests affected by a change
nx affected:e2e
# See a diagram of the dependencies of your projects
nx graph
```
### List of Tools
