mirror of
https://github.com/directus/directus.git
synced 2026-02-07 06:35:08 -05:00
73 lines
2.6 KiB
Markdown
73 lines
2.6 KiB
Markdown
<img width="250" alt="Logo" src="https://user-images.githubusercontent.com/9141017/88821768-0dc99800-d191-11ea-8c66-09c55ab451a2.png">
|
|
|
|
## 🐰 Introduction
|
|
|
|
Welcome to the preview release of the next major version of Directus.
|
|
|
|
**NOTE:** This is pre-release software and should be treated as such. DO NOT use this in production.
|
|
Migrations between versions aren't provided, and breaking changes might happen at any release.
|
|
|
|
## 🚧 Alpha
|
|
|
|
Note that this is an alpha version of the software. This means that certain features might be missing or broken. The following (big) features are still being worked on:
|
|
|
|
- [ ] GraphQL Endpoint
|
|
- [ ] MS SQL Support
|
|
- [ ] OracleDB Support
|
|
- [ ] App Permissions
|
|
- [ ] Import/Export Endpoints
|
|
- [ ] Caching
|
|
- [ ] Rate Limiting
|
|
|
|
See [the issue tracker](https://github.com/directus/next/issues) for a more in-depth list of all things coming up.
|
|
|
|
## ⚙️ Installation
|
|
|
|
_Directus requires NodeJS 10+_
|
|
|
|
We've created a little CLI tool you can use to quickly start up a Directus project. You can use it by running:
|
|
|
|
```
|
|
npx create-directus-project my-project
|
|
```
|
|
|
|
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.
|
|
|
|
## ✨ Updating
|
|
|
|
To update an existing Directus project, navigate to your project directory and run:
|
|
|
|
```
|
|
npm update
|
|
```
|
|
|
|
## 🔧 Contributing
|
|
|
|
Please report any and all quirks / issues you come across as [an issue](https://github.com/directus/next/issues/new).
|
|
|
|
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 :)
|
|
|
|
To install the project locally:
|
|
|
|
1. Clone the repo
|
|
2. Run `npm run bootstrap` in the root
|
|
3. Run `npm run dev` to start the dev environment for the Directus suite
|
|
|
|
## ❤️ Supporting Directus
|
|
|
|
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.
|
|
|
|
* [Support us through GitHub Sponsors](https://github.com/sponsors/directus)
|
|
* [One-time donation through PayPal](https://www.paypal.me/supportdirectus)
|
|
|
|
## 📄 License
|
|
|
|
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.
|
|
|