Explore popular projects built with Appwrite.
- Register Appwrite account
- Create project
- Install Appwrite CLI
- Login with
appwrite login
- Update project ID in
appwrite.json
- Deploy database structure with
appwrite deploy collection
- Deploy storage structure with
appwrite deploy bucket
- Deploy functions with
appwrite deploy function
- Set variables on deployed functions. Functions can be found in
functions
folder. They all haveREADME.md
describing what variables they need - Setup
GitHub
OAuth provider
- Install libraries
npm install
- Update projectID or endpoint in
src/AppwriteService.ts
, if not using production - Start server
npm run dev
Give moderators access to Appwrite Console. When project is good for publication, update isPublished
to true
and save document.
- Deploy frontend on root domain such as
myapp.com
- Add custom subdomain to Appwrite Project, such as
appwrite.myapp.com
- Add frontend domain as a platform in Appwrite project
To contribute to frontend, make sure to use the Pink Design design system. For state management, features of Qwik should be used. All logic related to communication with backend should be kept in src/AppwriteService.ts
.
When contributing to Appwrite Functions, use Appwrite CLI. Also use Appwrite CLI to sync changes to project structure such as databases, collections or buckets.
This project is using Qwik with QwikCity. QwikCity is just an extra set of tools on top of Qwik to make it easier to build a full site, including directory-based routing, layouts, and more.
Inside your project, you'll see the following directory structure:
โโโ public/
โ โโโ ...
โโโ src/
โโโ components/
โ โโโ ...
โโโ routes/
โโโ ...
-
src/routes
: Provides the directory based routing, which can include a hierarchy oflayout.tsx
layout files, and anindex.tsx
file as the page. Additionally,index.ts
files are endpoints. Please see the routing docs for more info. -
src/components
: Recommended directory for components. -
public
: Any static assets, like images, can be placed in the public directory. Please see the Vite public directory for more info.
Use the npm run qwik add
command to add additional integrations. Some examples of integrations include: Cloudflare, Netlify or Express server, and the Static Site Generator (SSG).
npm run qwik add # or `yarn qwik add`
Development mode uses Vite's development server. During development, the dev
command will server-side render (SSR) the output.
npm start # or `yarn start`
Note: during dev mode, Vite may request a significant number of
.js
files. This does not represent a Qwik production build.
The preview command will create a production build of the client modules, a production build of src/entry.preview.tsx
, and run a local server. The preview server is only for convenience to locally preview a production build, and it should not be used as a production server.
npm run preview # or `yarn preview`
The production build will generate client and server modules by running both client and server build commands. Additionally, the build command will use Typescript to run a type check on the source code.
npm run build # or `yarn build`
This starter site is configured to deploy to Vercel Edge Functions, which means it will be rendered at an edge location near to your users.
The adaptor will add a new vite.config.ts
within the adapters/
directory, and a new entry file will be created, such as:
โโโ adapters/
โโโ vercel-edge/
โโโ vite.config.ts
โโโ src/
โโโ entry.vercel-edge.tsx
Additionally, within the package.json
, the build.server
script will be updated with the Vercel Edge build.
To build the application for production, use the build
command, this command will automatically run npm run build.server
and npm run build.client
:
npm run build
To deploy the application for development:
npm run deploy
Notice that you might need a Vercel account in order to complete this step!
The project is ready to be deployed to Vercel. However, you will need to create a git repository and push the code to it.
You can deploy your site to Vercel either via a Git provider integration or through the Vercel CLI.