🖥️ Appwrite Console

Appwrite Console is the Graphical User Interface that developers interact with when accessing their Appwrite instance in the web browser.

Appwrite Console has been built with the following frameworks:

• Svelte
• Svelte Kit

Table of Contents:

• Development
  • Build
  • Tests
  • Format
  • Linter
  • Diagnostics
• Contributing
• Security
• Follow Us
• Licence

Development

Once you've created a project and installed dependencies with npm install, start a development server:

npm run dev

Build

npm run build

You can preview the built app with npm run preview, regardless of whether you installed an adapter. This should not be used to serve your app in production.

Tests

npm test

This will run tests in the tests/ directory.

Format

Code should like everywhere the same, for this reason a code-formatter is mandatory.

npm run format

Linter

npm run lint

Diagnostics

Diagnostic tool that checks for following:

• Unused CSS
• Svelte A11y hints
• TypeScript compiler errors

npm run check

Contributing

All code contributions - including those of people having commit access - must go through a pull request and be approved by a core developer before being merged. This is to ensure a proper review of all the code.

We truly ❤️ pull requests! If you wish to help, you can learn more about how you can contribute to this project in the contribution guide.

Security

For security issues, kindly email us at security@appwrite.io instead of posting a public issue on GitHub.

Follow Us

Join our growing community around the world! See our official Blog. Follow us on Twitter, Facebook Page, Facebook Group, Dev Community or join our live Discord server for more help, ideas, and discussions.

License

This repository is available under the BSD 3-Clause License.