Installations
npm install @foal/coreDeveloper Guide
Typescript
Yes
Module System
CommonJS
Min. Node Version
>=18.0.0
Node Version
20.17.0
NPM Version
lerna/8.1.7/node@v20.17.0+arm64 (darwin)
Score
61.3
Supply Chain
78.5
Quality
77
Maintenance
100
Vulnerability
99.6
License
Releases
Contributors
Unable to fetch Contributors
Languages
TypeScript (98.24%)
HTML (0.82%)
JavaScript (0.71%)
Shell (0.24%)
Developer
Download Statistics
Total Downloads
690,969
Last Day
93
Last Week
1,664
Last Month
7,536
Last Year
111,791
GitHub Statistics
1,901 Stars
5,672 Commits
142 Forks
23 Watching
10 Branches
63 Contributors
Bundle Size
818.30 kB
Minified
292.59 kB
Minified + Gzipped
Sponsor this package
Maintainers
Package Meta Information
Latest Version
4.5.1
Package Id
@foal/core@4.5.1
Unpacked Size
385.59 kB
Size
74.83 kB
File Count
238
NPM Version
lerna/8.1.7/node@v20.17.0+arm64 (darwin)
Node Version
20.17.0
Publised On
14 Sept 2024
Total Downloads
Cumulative downloads
Total Downloads
690,969
Last day
78.8%
93
Compared to previous day
Last week
-12.1%
1,664
Compared to previous week
Last month
-26.8%
7,536
Compared to previous month
Last year
-39.3%
111,791
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
What is Foal?
Foal (or FoalTS) is a Node.JS framework for creating web applications.
It provides a set of ready-to-use components so you don't have to reinvent the wheel every time. In one single place, you have a complete environment to build web applications. This includes a CLI, testing tools, frontend utilities, scripts, advanced authentication, ORM, deployment environments, GraphQL and Swagger API, AWS utilities, and more. You no longer need to get lost on npm searching for packages and making them work together. All is provided.
But while offering all these features, the framework remains simple. Complexity and unnecessary abstractions are put aside to provide the most intuitive and expressive syntax. We believe that concise and elegant code is the best way to develop an application and maintain it in the future. It also allows you to spend more time coding rather than trying to understand how the framework works.
Finally, the framework is entirely written in TypeScript. The language brings you optional static type-checking along with the latest ECMAScript features. This allows you to detect most silly errors during compilation and improve the quality of your code. It also offers you autocompletion and a well documented API.
Development Policy
Thousands of Tests
Testing FoalTS is put on a very high priority. Providing a reliable product is really important to us. As of December 2020, the framework is covered by more than 2100 tests.
Documentation
New features, no matter what they offer, are useless if they are not well documented. Maintaining complete and quality documentation is key to the framework. If you think something is missing or unclear, feel free to open an issue on Github!
Product Stability
Great attention is paid to the stability of the product. You can find out more by consulting our dependency policy, semantic versioning rules and long-term support policy.
:city_sunrise: Get started
First install Node.Js and npm.
Create a new app
npx @foal/cli createapp my-app
cd my-app
npm run dev
The development server is started! Go to http://localhost:3001 and find our welcoming page!
:point_right: Continue with the tutorial :seedling:
Backers
Community Chat
You can join the community chat here.
Contributing
See the contribution guidelines.
License
MIT
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
security policy file detected
Details
- Info: security policy file detected: .github/SECURITY.md:1
- Info: Found linked content: .github/SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: .github/SECURITY.md:1
- Info: Found text in security policy: .github/SECURITY.md:1
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
no binaries found in the repo
Reason
dependency not pinned by hash detected -- score normalized to 1
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/daily-test.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/FoalTS/foal/daily-test.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/daily-test.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/FoalTS/foal/daily-test.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/documentation.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/FoalTS/foal/documentation.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/documentation.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/FoalTS/foal/documentation.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/documentation.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/FoalTS/foal/documentation.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/documentation.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/FoalTS/foal/documentation.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/FoalTS/foal/test.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/FoalTS/foal/test.yml/master?enable=pin
- Warn: npmCommand not pinned by hash: e2e_test.sh:5
- Warn: npmCommand not pinned by hash: .github/workflows/daily-test.yml:30
- Warn: npmCommand not pinned by hash: .github/workflows/documentation.yml:64
- Warn: npmCommand not pinned by hash: .github/workflows/documentation.yml:26
- Warn: npmCommand not pinned by hash: .github/workflows/test.yml:34
- Warn: npmCommand not pinned by hash: .github/workflows/test.yml:36
- Info: 0 out of 8 GitHub-owned GitHubAction dependencies pinned
- Info: 2 out of 8 npmCommand dependencies pinned
Reason
1 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/daily-test.yml:1
- Warn: no topLevel permission defined: .github/workflows/documentation.yml:1
- Warn: no topLevel permission defined: .github/workflows/test.yml:1
- Info: no jobLevel write permissions found
Reason
Found 0/11 approved changesets -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 25 are checked with a SAST tool
Reason
10 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Score
3.5
/10
Last Scanned on 2024-12-23
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More