0.0.1-alpha.0 • Published 7 years ago
@amilajack/cli v0.0.1-alpha.0
Alfred

🛠 Status: In Development
Alfred is currently in development. It's on the fast track to a 1.0 release, so we encourage you to use it and give us your feedback, but there are things that haven't been finalized yet and you can expect some changes.
What is Alfred?
- An alternative to boilerplates / starter kits
- Better tooling, out of the box
- A solution to brittle and complex JS infrastructure
Getting Started
# Create a new project
NPM_CONFIG_REGISTRY=https://amilajack.com/registry npx alfred new my-project
cd my-project
# Build your project
npx alfred run buildDocs
Examples
See our examples directory
| Icon | Status |
|---|---|
| ✅ | Basic implementation finish |
| 🔨 | Implementation in progress |
| ❌ | To be implemented, Help wanted! |
| Example | Descrption | |
|---|---|---|
| 1. | hello world node | A simple hello work app in node |
| 2. | react library | A small button library built with React |
| 3. | typescript react app | ❌ |
Implemented Skills
| Infrastructure | Skills | Implemented |
|---|---|---|
| Bundlers | Webpack, Rollup, Parcel | ✅ ✅ ✅ |
| Transpilers | Babel | ✅ |
| Test Frameworks | Jest, Mocha, Jasmine, Ava | ✅ ✅ ❌ ❌ |
| Formatters | Prettier | ✅ |
| Libraries | Lodash, Moment | ✅ ❌ |
| Linters | ESLint | ✅ |
| Front End | React, Vue, Angular | ✅ ❌ ❌ |
| State Managment | Redux, Mobx | ✅ ❌ |
| Routing | react-router | ❌ |
| Query Languages | graphql, apollo | ❌ ❌ |
| Documentation | ESDoc, Typedoc | ❌ ❌ |
| Migration | Lebab | ❌ |
| Type Checkers | Flow, TypeScript | ❌ ❌ |
| End to End Testing | TestCafe, Cypress | ❌ ❌ |
Implemented Targets
| Target | Implemented |
|---|---|
| Browser | ✅ |
| Node | ✅ |
| Electron | ❌ |
| React Native | ❌ |
Prior Art
- Cargo
- NPM, Yarn
- Yeoman
- create-react-app
- react-boilerplate, electron-react-boilerplate, and many many other boilerplates
Inspiration
Contributing
See CONTRIBUTING.md
Donations
If this project is saving you (or your team) time, please consider supporting it on Patreon 👍 thank you!
Donations will ensure the following:
- 🔨 Long term maintenance of the project
- 🛣 Progress on the roadmap
- 🐛 Quick responses to bug reports and help requests
Please donate to our Patreon or PayPal
Community
All feedback and suggestions are welcome!
- 💬 Join the community on Spectrum
- 📣 Stay up to date on new features and announcements on @alfredpkg.
Goals
- Standardize and simplify JS infrastructure and conventions
- Encourage extensible and reusable infrastructure configuration
- Provide opinionated configuration out of the box that meets the needs of most users
0.0.1-alpha.0
7 years ago