The urca generator will help you create a JavaScript or TypeScript application in your working directory. To create your library project, navigate to a new project folder and then use Yeoman to generate your application:
npm init yo urcaThe generator will ask you a few questions and will generate it for you.
- app name
- app description
- app keywords
- public or private repository
- JavaScript or TypeScript
- add or not React to demo page
- GitHub username
- GitHub email
- first and last name
- dependencies:
When the installation process is over, this is the file structure that will be generated:
.
├── demo/ # demo page
│ └── index.html
│ └── index.j(t)s(x)
│ └── style.css
├── dist/ # distributable version of app built using Parcel
├── node_modules/ # npm managed libraries
├── src/ # project source code
│ └── lib/ # folder for your library
│ └── hello.j(t)s
│ └── index.j(t)s # app entry point
├── .eslintrc.js
├── .gitignore
├── .prettierignore
├── .prettierrc.js
├── .yo-rc.json
├── LICENSE
├── package.json
├── README.md
├── (tsconfig.json)
├── yarn.lock- Prettier to format your code
- Eslint to lint your code
- Parcel to automagically compile ES6
- TypeScript
- React to simplify the demo page development
- Git initialization
- README
- MIT license
Once you have created the structure of your new app, these are the prompt commands you can run:
yarn start:demo: to preview and watch for demo page changes (http://localhost:1234)yarn build: to build your webapp for production in/dist
This project is still in progress. Anyway, if you open an issue (or a PR), I will be happy :)
- Jest because testing matters
- React
- to lib
- to demo page
- tailwind instead of tachyons