nodal-components
v1.0.3
Published
One Paragraph of project description goes here
Downloads
3
Readme
Pawkit
One Paragraph of project description goes here
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Prerequisites
- NodeJS version 20.x (iron)
- NPM version 10.x
- VS Code (Recommended)
You could nvm to manage mutlple versions of NodeJS in your OS.
Installing
- Install dependencies
npm i
Running the tests
npm run test
This will test each component, screen for
- Expected functionality
- Expected rendering
TODO: example
Running the development app
npm start
Running the development with storybook
npm run storybook
And coding style tests
- npm run lint
This will make sure the codes are written with the recommended coding style and clean
Deployment
Add additional notes about how to deploy this on a live system
Built With
- Expo - react native tools and services
- Tamagui - Style system
- Amplify for React Native - Full-stack deployment
- GraphQL - API
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.