Repository files navigation

⚠️ No longer maintained!!! Read this#826

A marvelous Open Source Status Page system

Statusfy is a Status Page System, easy to use and completely Open Source. You can easily create a fast System eitherStatic Generated orServer Rendered and easily deploy it to a variety ofhosting services.

A Statusfy site is a Web Application, created withVue,Nuxt.js andTailwind CSS. We useVue to dynamically define the interfaces that represent the data,Nuxt.js to make a quick and useful abstraction of the client and server logic, andTailwind CSS to rapidly define the default theme.

• Systems Definition
• Incidents Reports
• Progressive Web App (PWA) Support
• Google Analytics Integration
• Multi-language support
• A default theme with:
  • Responsive layout
  • Easy Customization
  • Beautiful Design
• SEO Friendly
• Hosting flexibility: Static Generated or Server Rendered

We love Open Source Projects, we use them every day andStatusfy is our contribution to the community. Statusfy is created and maintained byBazzite, a Software Development Company, but our resources are limited. If you want to support our work and help us to continue developing this Amazing Project,please donate,we will appreciate it ❤️.

This is how we use the donations:

• Allow the core team to work on Statusfy.
• Support external projects in the ecosystem.
• Cover any other expense.
• Thank contributors if they invested a large amount of time in contributing.

Become a Partner and get your logo with a link to your site on our README on Github,every page ofhttps://docs.statusfy.co and, thehome page andeach blog post ofhttps://statusfy.co. [Become a Partner]

Become a Sponsor and get your logo on our README on Github with a link to your site.. [Become a Sponsor]

Support us with a monthly donation and help us continue our activities. It means a lot to us ❤️. [Become a Backer]

It’s pretty easy to get started with Statusfy. Install it globally with npm:

Make sure you havenpx installed (npx is shipped by default sincenpm 5.2.0)

# change the working directorycd existing_folder# run the initialization commandnpx statusfy init# and install your local dependenciesnpm install# OR yarn install

Create a new incident with this command:

npm run new-incident# OR yarn new-incident

and launch the development server with:

npm run dev# OR yarn dev

You can also generate a Static Generated Website with:

npm run generate# OR yarn generate

or generate a Server Rendered Website with:

# generate static assetsnpm run build# OR yarn build# launch the servernpm run start# OR yarn start

More information in theDocumentation.

⚠️ You must at least usenode >= 8.10.

# install dependenciesyarn# serves Statusfy's own demoyarn demo:dev# make sure your code change passes the testyarntest

More information in theContributing Guide.You can also build and run Statusfy in a free online workspace using Gitpod:

A Demo application is athttps://demo.statusfy.co.

• 📄 If you want extra details of how to configure and use this project, thefull documentation is available athttps://docs.statusfy.co.
• 💻 You may want to check theexamples projects for different popular hosting services atthe Examples Repository.
• 🐞 ForBug reports orFeature requests, use theIssues section.
• 💬 Forquestions, go tohttps://spectrum.chat/bazzite/statusfy.
• 🤓 You can find usefularticles inour blog.
• 🚀 You may also want tofollow the company supporting this projecton Twitter.

This project is sponsored byBazzite. If you require Professional Assistance on your project(s), please contact us athttps://statusfy.co/support.

Please make sure to read theContributing Guide before making a pull request.

Everyone participating in this project is expected to agree to abide by theCode of Conduct.

Code released under theApache License 2.0.