We would ❤️ for you to contribute to Appwrite and help make it better! We want contributing to Appwrite to be fun, enjoyable, and educational for anyone and everyone. All contributions are welcome, including issues, new docs as well as updates and tweaks, blog posts, workshops, and more.
If you are worried or don’t know where to start, check out our next section explaining what kind of help we could use and where can you get involved. You can reach out with questions to Eldad Fux (@eldadfux) or @appwrite on Twitter, and anyone from the Appwrite team on Discord. You can also submit an issue, and a maintainer can guide you!
Help us keep Appwrite open and inclusive. Please read and follow our Code of Conduct.
Branch naming convention is as following
TYPE-ISSUE_ID-DESCRIPTION
example:
doc-548-submit-a-pull-request-section-to-contribution-guide
When TYPE can be:
- feat - is a new feature
- doc - documentation only changes
- cicd - changes related to CI/CD system
- fix - a bug fix
- refactor - code change that neither fixes a bug nor adds a feature
All PRs must include a commit message with the changes description!
For the initial start, fork the project and use git clone command to download the repository to your computer. A standard procedure for working on an issue would be to:
git pull, before creating a new branch, pull the changes from upstream. Your master needs to be up to date.
$ git pull
- Create new branch from
masterlike:doc-548-submit-a-pull-request-section-to-contribution-guide
$ git checkout -b [name_of_your_new_branch]
-
Work - commit - repeat ( be sure to be in your branch )
-
Push changes to GitHub
$ git push origin [name_of_your_new_branch]
- Submit your changes for review
If you go to your repository on GitHub, you'll see aCompare & pull requestbutton. Click on that button. - Start a Pull Request
Now submit the pull request and click onCreate pull request. - Get a code review approval/reject
- After approval, merge your PR
- GitHub will automatically delete the branch after the merge is done. (they can still be restored).
To set up a working development environment, just fork the project git repository and install the backend and frontend dependencies using the proper package manager and create run the docker-compose stack.
If you just want to install Appwrite for day-to-day usage and not as a code maintainer use this installation guide.
Please note that these instructions are for setting a functional dev environment. If you want to set up an Appwrite instance to integrate into your app, you should probably try and install Appwrite by using the instructions in the getting started guide or in the main README file.
git clone [email protected]:[YOUR_FORK_HERE]/appwrite.git
cd appwrite
docker-compose up -dTo get proper autocompletion for all the different functions and classes in the codebase, you'll need to install Appwrite dependencies on your local machine. You can easily do that with PHP's package manager, Composer. If you don't have Composer installed, you can use the Docker Hub image to get the same result:
docker run --rm --interactive --tty \
--volume $PWD:/app \
composer update --ignore-platform-reqs --optimize-autoloader --no-plugins --no-scripts --prefer-distAppwrite uses an internal micro-framework called Litespeed.js to build simple UI components in vanilla JS and less for compiling CSS code. To apply any of your changes to the UI, use the gulp build or gulp less commands, and restart the Appwrite main container to load the new static files to memory using docker-compose restart appwrite.
After finishing the installation process, you can start writing and editing code.
We love to create issues that are good for beginners and label them as good first issue or hacktoberfest, but some more advanced topics might require extra knowledge. Below is a list of links you can use to learn more about some of the more advance topics that will help you master the Appwrite codebase.
- Docker
- PHP FIG - PSR-1 and PSR-4
- PHP Swoole
Learn more at our Technology Stack section.
- Microservices vs Monolithic
- MVVM - Appwrite console architecture
Appwrite's current structure is a combination of both Monolithic and Microservice architectures, but our final goal, as we grow, is to be using only microservices.
.
├── app # Main application
│ ├── config # Config files
│ ├── controllers # API & dashboard controllers
│ │ ├── api
│ │ ├── shared
│ │ └── web
│ ├── db # DB schemas
│ ├── sdks # SDKs generated copies (used for generating code examples)
│ ├── tasks # Server CLI commands
│ ├── views # HTML server-side templates
│ └── workers # Background workers
├── bin # Server executables (tasks & workers)
├── docker # Docker related resources and configs
├── docs # Docs and tutorials
│ ├── examples
│ ├── references
│ ├── services
│ ├── specs
│ └── tutorials
├── public # Public files
│ ├── dist
│ ├── fonts
│ ├── images
│ ├── scripts
│ └── styles
├── src # Supporting libraries (each lib has one role, common libs are released as individual projects)
│ └── Appwrite
│ ├── Auth
│ ├── Database
│ ├── Detector
│ ├── Docker
│ ├── Event
│ ├── Extend
│ ├── Migration
│ ├── Network
│ ├── OpenSSL
│ ├── Realtime
│ ├── Resque
│ ├── Specification
│ ├── Task
│ ├── Template
│ ├── URL
│ └── Utopia
└── tests # End to end & unit tests
├── e2e
├── resources
└── unitAppwrite's main API container is designed as a monolithic app. This is a decision we made to allow us to develop the project faster while still being a very small team.
Although the Appwrite API is a monolithic app, it has a very clear separation of concern as each internal service or worker is separated by its container, which will allow us as we grow to start breaking services for better maintenance and scalability.
Each container in Appwrite is a microservice on its own. Each service is an independent process that can scale without regard to any of the other services.
Currently, all of the Appwrite microservices are intended to communicate using the TCP protocol over a private network. You should be aware to not expose any of the services to the public-facing network, besides the public port 80 and 443, who, by default, are used to expose the Appwrite HTTP API.
Appwrite dev version uses ports 80 and 443 as an entry point to the Appwrite API and console. We also expose multiple ports in the range of 9500-9504 for debugging some of the Appwrite containers on dev mode. If you have any conflicts with the ports running on your system, you can easily replace them by editing Appwrite's docker-compose.yml file and executing docker-compose up -d command.
To start helping us to improve the Appwrite server by submitting code, prior knowledge of Appwrite's technology stack can help you with getting started.
Appwrite stack is combined from a variety of open-source technologies and tools. Appwrite backend API is written primarily with PHP version 7 and above on top of the Utopia PHP framework. The Appwrite frontend is built with tools like gulp, less, and litespeed.js. We use Docker as the container technology to package the Appwrite server for easy integration on-cloud, on-premise, or on-localhosts.
- Redis - for managing cache and in-memory data (currently, we do not use Redis for persistent data)
- MariaDB - for database storage and queries
- InfluxDB - for managing stats and time-series based data
- Statsd - for sending data over UDP protocol (using Telegraf)
- ClamAV - for validating and scanning storage files
- Imagemagick - for manipulating and managing image media files.
- Webp - for better compression of images on supporting clients
- SMTP - for sending email messages and alerts
- Resque - for managing data queues and scheduled tasks over a Redis server
Appwrite uses a package manager for managing code dependencies for both backend and frontend development. We try our best to avoid creating any unnecessary, and any new dependency to the project is subjected to a lead developer review and approval.
Many of Appwrite's internal modules are also used as dependencies to allow other Appwrite's projects to reuse them and as a way to contribute them back to the community.
Appwrite uses PHP's Composer for managing dependencies on the server-side and JS NPM for managing dependencies on the frontend side.
Appwrite is following the PHP-FIG standards. Currently, we are using both PSR-0 and PSR-4 for coding standards and autoloading standards. Soon we will also review the project for support with PSR-12 (Extended Coding Style).
We use prettier for our JS coding standards and auto-formatting our code.
Appwrite is built to scale. Please keep in mind that the Appwrite stack can run in different environments and different scales.
We wish Appwrite will be as easy to set up and in a single, localhost, and easy to grow to a large environment with dozens and even hundreds of instances.
When contributing code, please take into account the following considerations:
- Response Time
- Throughput
- Requests per Seconds
- Network Usage
- Memory Usage
- Browser Rendering
- Background Jobs
- Task Execution Time
Security and privacy are extremely important to Appwrite, developers, and users alike. Make sure to follow the best industry standards and practices.
Please avoid introducing new dependencies to Appwrite without consulting the team. New dependencies can be very helpful but also introduce new security and privacy issues, complexity, and impact total docker image size.
Adding a new dependency should have vital value on the product with minimum possible risk.
We would 💖 you to contribute to Appwrite, but we would also like to make sure Appwrite is as great as possible and loyal to its vision and mission statement 🙏.
For us to find the right balance, please open an issue explaining your ideas before introducing a new pull request.
This will allow the Appwrite community to have sufficient discussion about the new feature value and how it fits in the product roadmap and vision.
This is also important for the Appwrite lead developers to be able to give technical input and different emphasis regarding the feature design and architecture. Some bigger features might need to go through our RFC process.
To build a new version of the Appwrite server, all you need to do is run the build.sh file like this:
bash ./build.sh X.X.XBefore running the command, make sure you have proper write permissions to the Appwrite docker hub team.
Build for Multicore
docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v6,linux/arm/v7,linux/arm64/v8,linux/ppc64le,linux/s390x -t appwrite/appwrite:dev --push .Build Functions Runtimes
The Runtimes for all supported cloud functions (multicore builds) can be found at the open-runtimes/open-runtimes repository.
For generating a new console SDK follow the next steps:
- Update the console spec file located at
app/config/specs/swagger2-0.12.x.console.jsonfrom the dynamic version located athttps://localhost/specs/swagger2?platform=console - Generate a new SDK using the command
php app/cli.php sdks - Change your working dir using
cd app/sdks/console-web - Build the new SDK
npm run build - Copy
iife/sdk.jstoappwrite.js - Go back to the root of the project
run npm run build
Things to remember when releasing SDKs
- Update the Changelogs in docs/sdks (right now only Dart and Flutter are using these)
- Update GETTING_STARTED.md in docs/sdks for each SDKs if any changes in the related APIs in there
- Update SDK versions as required on app/config/platforms.php
- Generate SDKs using the command
php app/cli.php sdksand follow the instructions - Release new tags on GitHub repository for each SDKs
Appwrite uses yasd debugger, which can be made available during build of Appwrite. You can connect to the debugger using VS Code PHP Debug extension or if you are in PHP Storm you don't need any plugin. Below are the settings required for remote debugger connection.
First, you need to create an init file. Duplicate dev/yasd_init.php.stub file and name it dev/yasd_init.php and there change the IP address to your development machine's IP. Without the proper IP address debugger wont connect. And you also need to set DEBUG build arg in appwrite service in docker-compose.yml file.
{
"name": "Listen for Xdebug",
"type": "php",
"request": "launch",
"port": 9005,
"pathMappings": {
"/usr/src/code": "${workspaceRoot}"
},
}In settings, go to Languages & Frameworks > PHP > Debug, there under Xdebug set the debug port to 9005 and enable can accept external connections checkbox.
To run all tests manually, use the Appwrite Docker CLI from your terminal:
docker-compose exec appwrite testTo run unit tests use:
docker-compose exec appwrite test /usr/src/code/tests/unitTo run end-2-end tests use:
docker-compose exec appwrite test /usr/src/code/tests/e2eTo run end-2-end tests for a spcific service use:
docker-compose exec appwrite test /usr/src/code/tests/e2e/Services/[ServiceName]You can use WRK Docker image to benchmark the server performance. Benchmarking is extremely useful when you want to compare how the server behaves before and after a change has been applied. Replace [APPWRITE_HOSTNAME_OR_IP] with your Appwrite server hostname or IP. Note that localhost is not accessible from inside the WRK container.
Options:
-c, --connections <N> Connections to keep open
-d, --duration <T> Duration of test
-t, --threads <N> Number of threads to use
-s, --script <S> Load Lua script file
-H, --header <H> Add header to request
--latency Print latency statistics
--timeout <T> Socket/request timeout
-v, --version Print version details
docker run --rm skandyla/wrk -t3 -c100 -d30 https://[APPWRITE_HOSTNAME_OR_IP]We use some automation tools to help us keep a healthy codebase.
Improve PHP execution time by using fully-qualified function calls:
php-cs-fixer fix src/ --rules=native_function_invocation --allow-risky=yesCoding Standards:
php-cs-fixer fix app/controllers --rules='{"braces": {"allow_single_line_closure": true}}'php-cs-fixer fix src --rules='{"braces": {"allow_single_line_closure": true}}'Static Code Analysis:
docker-compose exec appwrite /usr/src/code/vendor/bin/psalmFrom time to time, our team will add tutorials that will help contributors find their way in the Appwrite source code. Below is a list of currently available tutorials:
- Adding Support for a New OAuth2 Provider
- Appwrite Environment Variables
- Running in Production
- Adding Storage Adapter
Pull requests are great, but there are many other areas where you can help Appwrite.
Blogging, speaking about, or creating tutorials about one of Appwrite’s many features. Mention @appwrite on Twitter and/or email [email protected] so we can give pointers and tips and help you spread the word by promoting your content on the different Appwrite communication channels. Please add your blog posts and videos of talks to our Awesome Appwrite repo on GitHub.
Presenting at meetups and conferences about your Appwrite projects. Your unique challenges and successes in building things with Appwrite can provide great speaking material. We’d love to review your talk abstract/CFP, so get in touch with us if you’d like some help!
Sending feedback is a great way for us to understand your different use cases of Appwrite better. If you had any issues, bugs, or want to share about your experience, feel free to do so on our GitHub issues page or at our Discord channel.
If you think Appwrite could use a new feature, please open an issue on our GitHub repository, stating as much information as you can think about your new idea and it's implications. We would also use this issue to gather more information, get more feedback from the community, and have a proper discussion about the new feature.
Submitting documentation updates, enhancements, designs, or bug fixes. Spelling or grammar fixes will be very much appreciated.
Searching for Appwrite on Discord, GitHub, or StackOverflow and helping someone else who needs help. You can also help by teaching others how to contribute to Appwrite's repo!