github/directus
1
0
Fork 0
mirror of https://github.com/directus/directus.git synced 2026-01-23 12:48:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

new api readme for npm

Browse Source
This commit is contained in:
Ben Haynes
2020-12-09 16:06:54 -05:00
parent 1ab1b3b268
commit 73a4c756fd
1 changed files with 42 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
api/README.md
View File

@@ -1,28 +1,46 @@
<img width="250" alt="Logo" src="https://user-images.githubusercontent.com/9141017/88821768-0dc99800-d191-11ea-8c66-09c55ab451a2.png">
<p align="center"><a href="https://directus.io" target="_blank" rel="noopener noreferrer"><img width="250" alt="Logo" src="https://user-images.githubusercontent.com/9141017/88821768-0dc99800-d191-11ea-8c66-09c55ab451a2.png"></a></p>
## 🐰 Introduction
<p>&nbsp;</p>
Welcome to the preview release of the next major version of Directus.
<h2 align="center">Introduction</h2>
## ⚙️ Installation
**Directus is a free and open-source data platform for headless content management**. It can be installed on top of any new or existing SQL database, instantly providing a dynamic API (REST+GraphQL) and accompanying App for managing content. Built entirely in TypeScript (in Node and Vue), Directus is completely modular and end-to-end extensible... with absolutely no paywalls or artificial limitations.
_Directus requires NodeJS 10+_
Modern and intuitive, the Directus App enables no-code data discovery, allowing for even the most non-technical users to view, author, and manage your raw database content. Our performant and flexible API is able to adapt to any relational schema, and includes rule-based permissions, event/web hooks, custom endpoints, numerous auth options, configurable storage adapters, and much more.
We've created a little CLI tool you can use to quickly start up a Directus project. You can use it by running:
Current database support includes: PostgreSQL, MySQL, SQLite, MS-SQL Server, OracleDB, MariaDB, and varients such as AWS Aurora/Redshift or Google Cloud Platform SQL.
Learn more at...
* [Website](https://directus.io/)
* [GitHub](https://github.com/directus/directus)
* [Community](https://directus.chat/)
* [Twitter](https://twitter.com/directus)
* [Docs](https://docs.directus.io/)
* [Marketplace](https://directus.market/)
* [Cloud](http://directus.cloud/)
<p>&nbsp;</p>
## Installing
Directus requires NodeJS 10+. Create a new project with our simple CLI tool:
```
npx create-directus-project my-project
```
or using yarn:
Or using yarn:
```
yarn create directus-project my-project
```
on the command line. This will create the given directory, setup the configuration, and install the database.
The above command will create a directory with your project name, then walk you through the database configuration and creation of your first admin user.
## ✨ Updating
<p>&nbsp;</p>
## Updating
To update an existing Directus project, navigate to your project directory and run:
@@ -30,19 +48,25 @@ To update an existing Directus project, navigate to your project directory and r
npm update
```
## 🔧 Contributing
<p>&nbsp;</p>
Please report any and all quirks / issues you come across as [an issue](https://github.com/directus/directus/issues/new).
## Contributing
Pull requests are more than welcome and always appreciated. Seeing this is in active development, please make sure to reach out a member of the core team in an issue or [on Discord](http://discord.gg/directus) before you start working on a feature or bug to ensure you don't work on the same thing as somebody else :)
Please report any and all issues [on our GitHub](https://github.com/directus/directus/issues/new).
## ❤️ Supporting Directus
Pull-requests are more than welcome, and always appreciated. Please read our [Contributors Guide](https://docs.directus.io/getting-started/contributing.html) before starting work on a new feature or bug, or reach out a member of the Core Team via [GitHub](https://github.com/directus/directus/discussions) or [Discord](https://directus.chat) with any questions.
Directus is a GPLv3-licensed open source project with development made possible by support from our core team, contributors, and sponsors. It's not easy building premium open-source software; if you would like to help ensure Directus stays free, please consider becoming a sponsor.
<p>&nbsp;</p>
- [Support us through GitHub Sponsors](https://github.com/sponsors/directus)
- [One-time donation through PayPal](https://www.paypal.me/supportdirectus)
## Supporting
## 📄 License
Directus is a free and open-source project with development made possible by support from our passionate core team, amazing contributors, and generous sponsors. It's not easy building premium open-source software; if you would like to help ensure Directus stays free, please consider becoming a sponsor.
Directus is released under [the GPLv3 license](./license). Monospace Inc. owns all Directus trademarks and logos on behalf of our project's community. Copyright © 2006-2020, Monospace Inc.
* [Support us through GitHub Sponsors](https://github.com/sponsors/directus)
* [One-time donation through PayPal](https://www.paypal.me/supportdirectus)
<p>&nbsp;</p>
## License
Directus is released under the [GPLv3 license](./license). Monospace Inc owns all Directus trademarks, logos, and intellectual property on behalf of our project's community. Copyright © 2004-2020, Monospace Inc.