Skip to content

amilajack/alfred

Repository files navigation

Alfred

Github Actions Join the community on Spectrum Twitter Follow

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
npx alfred new my-project
cd my-project

# Build your project
npx alfred run build

Docs

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 world 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

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