silvestreperret / foal Goto Github PK

🔥 A Web framework to create enterprise-grade Node.JS applications 💥 🚀

Website - Documentation - Twitter

Install Node.Js and npm.

$ npm install -g @foal/cli
$ foal createapp my-app
$ cd my-app && npm install
$ npm run develop

Go to http://localhost:3000 and find our welcoming page!

Create a model.

$ foal g entity flight

Create a resource collection.

$ foal g service flight
> EntityResourceCollection

Create a REST controller.

$ foal g controller flight --register
> REST

The npm run develop command rebuilds the app and reloads the server. http://localhost:3000/flights now returns an empty array!

>> Continue with the tutorial

Feel free to ask a question by submitting an issue.

FoalTS provides an advanced configuration system to smoothly switch between your environments. How you specify the configuration may change between deploys (env variables, json files, etc). But your codebase stays the same.

TypeScript brings you optional static type-checking along with the latest ECMAScript features. Writing FoalTS with TypeScript has been and will always be fundamental. Code is more elegant and concise. Most of the silly mistakes are caught at compilation. And autocompletion is well-handled and the API is better documented.

Every project needs dev tools. But setting up and maintaining such an environment in Node.Js is often hard or time consuming. FoalTS focuses on helping the developer to code. Generators, watchers, the compiler, linter, bundler and test framework are all provided in FoalTS. No more set up, get started right away.

Some patterns always come back while developing a web app. Set up a REST API, talk to the database or manage authentication shouldn't be a hard task. FoalTS lets you focus on the business logic, not on re-inventing the wheel.

FoalTS doesn't aim to be a closed framework. Some technologies in the Node.Js ecosystem are great and you should be able to use them in your apps. To do so FoalTS ecosystem provides separate packages including these technologies.

Security is everyone's business. To help you ship secure apps FoalTS provides some common tools (csrf, xss protections) to take care of it. Moreover all default configurations are set to prevent security failures (cookies, headers, etc).

See the contribution guidelines

MIT