eliott/Nimbus
1
0
Fork 0
mirror of https://github.com/nimbusdotstorage/Nimbus synced 2026-04-22 17:45:03 +02:00
Code Issues Packages Projects Releases Wiki Activity

chore: infinite line length for markdown. prettier ignore CHANGELOG.md

Browse Source
This commit is contained in:
David Bauch
2025-08-04 11:28:42 -04:00
parent fe08e7a813
commit e29398a761
4 changed files with 20 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.prettierignore
View File

@@ -30,3 +30,6 @@ drizzle/
# If you have serverless function output directories (e.g., Vercel, Netlify)
**/.vercel/
# Changelog
CHANGELOG.md

2
.prettierrc
View File

@@ -19,7 +19,7 @@
"files": ".*.ts"
},
{
"files": ".github/workflows/*.yml",
"files": [".github/workflows/*.yml", "*.md"],
"options": {
"printWidth": 9999
}

25
CONTRIBUTING.md
View File

@@ -48,11 +48,7 @@ git push origin feature/your-feature-name
- Go to GitHub and open a pull request from your feature branch
> Note: If you open a pull request, try to minimize the amount of repo wide changes you make. It will highly increase
> the chances that we just review and merge. We're much more likely to question and challenge changes if they do not
> make sense to the actual features or fixes the PR was intended for. Example: adding unneeded dependencies for the
> server when the PR was for a dialog component, or changing the middleware functionality when you were working on
> better error handling on the server
> Note: If you open a pull request, try to minimize the amount of repo wide changes you make. It will highly increase the chances that we just review and merge. We're much more likely to question and challenge changes if they do not make sense to the actual features or fixes the PR was intended for. Example: adding unneeded dependencies for the server when the PR was for a dialog component, or changing the middleware functionality when you were working on better error handling on the server
## Useful Commands
@@ -71,28 +67,22 @@ git push origin feature/your-feature-name
## Troubleshooting
- **Port conflicts**: If port 5432 is already in use, just change the port mapping in `docker-compose.yml`
- **Permission issues**: On Linux, you might need to run Docker commands with `sudo` or add your user to the `docker`
group with the command `sudo usermod -aG docker $USER`
- **Database connection issues**: Ensure the database is running and the connection string in your `.env` file is
correct
- **Permission issues**: On Linux, you might need to run Docker commands with `sudo` or add your user to the `docker` group with the command `sudo usermod -aG docker $USER`
- **Database connection issues**: Ensure the database is running and the connection string in your `.env` file is correct
## License
By contributing to this project, you agree that your contributions will be licensed under its
[Apache License 2.0](LICENSE).
By contributing to this project, you agree that your contributions will be licensed under its [Apache License 2.0](LICENSE).
---
## For new contributors
We want everyone to be able to contribute something to Nimbus. So we set up a list of a few items that can get you
started contributing to the project. This will be updated as needed.
We want everyone to be able to contribute something to Nimbus. So we set up a list of a few items that can get you started contributing to the project. This will be updated as needed.
### 1. Storage source support
If you have experience with the APIs or specs for S3, R2, OneDrive, or any other storage source, we would love it if you
help us add support for it. Try to stay as close to the API spec as possible, especially for S3 storage so we can
support S3 compatible storage sources like MinIO.
If you have experience with the APIs or specs for S3, R2, OneDrive, or any other storage source, we would love it if you help us add support for it. Try to stay as close to the API spec as possible, especially for S3 storage so we can support S3 compatible storage sources like MinIO.
### 2. UI/UX improvements
@@ -109,8 +99,7 @@ Some items to get started with:
- A settings page that functions with the providers and user settings
- Add folder tree navigation, breadcrumbs, or a file previewer
We realize that many of these changes will not have total functionality hooked up yet. Thats fine, just make sure to add
dummy data so we can see the UI and make sure it works as expected before adding real data.
We realize that many of these changes will not have total functionality hooked up yet. Thats fine, just make sure to add dummy data so we can see the UI and make sure it works as expected before adding real data.
### 3. Backend Improvements

30
DEPLOYMENT.md
View File

@@ -104,8 +104,7 @@ Your container should now be available at [http://localhost:3000](http://localho
- [Wrangler CLI](https://developers.cloudflare.com/workers/wrangler/install-and-update/)
- Cloudflare account with Workers enabled
> For any issues, please refer to the official Cloudflare Workers
> [documentation](https://developers.cloudflare.com/workers/).
> For any issues, please refer to the official Cloudflare Workers [documentation](https://developers.cloudflare.com/workers/).
### 1. Install Dependencies and Sign In to Wrangler
@@ -117,25 +116,18 @@ bun wrangler login
### 2. Configure Worker
The `wrangler.toml` is already configured to instantly deploy, however you will need to add certain environment
variables for the worker to function fully.
The `wrangler.toml` is already configured to instantly deploy, however you will need to add certain environment variables for the worker to function fully.
If testing, make sure to add the wrangler.dev url cloudflare provisions for you to the `NEXT_PUBLIC_BACKEND_URL` and
`NEXT_PUBLIC_FRONTEND_URL` environment variables in both the wrangler.toml and .env files.
If testing, make sure to add the wrangler.dev url cloudflare provisions for you to the `NEXT_PUBLIC_BACKEND_URL` and `NEXT_PUBLIC_FRONTEND_URL` environment variables in both the wrangler.toml and .env files.
If deploying to production, make sure to use your production url in the `NEXT_PUBLIC_BACKEND_URL` and
`NEXT_PUBLIC_FRONTEND_URL` environment variables in both the wrangler.toml and .env files.
If deploying to production, make sure to use your production url in the `NEXT_PUBLIC_BACKEND_URL` and `NEXT_PUBLIC_FRONTEND_URL` environment variables in both the wrangler.toml and .env files.
1. Add the values outlined in the .env.example file to the wrangler.toml file or to your Worker settings on the
Cloudflare dashboard.
1. Add the values outlined in the .env.example file to the wrangler.toml file or to your Worker settings on the Cloudflare dashboard.
2. Configure your .env file with your production values.
3. Run `bun env:sync` to sync your .env file to the web workspace or the frontend build will fail.
4. Run `cp .env .dev.vars` to copy your .env file to the .dev.vars file for testing it locally before deployment.
> **Note:** The worker front end is build with [opennext](https://opennext.js.org/) and therefore acts exactly as a
> Nextjs build, so env variables are extracted from the .env file at the root of the workspace (`apps/web` in this
> case). Technically, the only variables required for the frontend build are `NEXT_PUBLIC_BACKEND_URL` and
> `NEXT_PUBLIC_FRONTEND_URL`, but it is recommended to sync all variables.
> **Note:** The worker front end is build with [opennext](https://opennext.js.org/) and therefore acts exactly as a Nextjs build, so env variables are extracted from the .env file at the root of the workspace (`apps/web` in this case). Technically, the only variables required for the frontend build are `NEXT_PUBLIC_BACKEND_URL` and `NEXT_PUBLIC_FRONTEND_URL`, but it is recommended to sync all variables.
### 3. Deploy Worker
@@ -147,22 +139,18 @@ bun run deploy
### 4. Set Up Custom Domain (Optional)
Refer to the official [documentation](https://developers.cloudflare.com/workers/configuration/routing/custom-domains/)
for adding custom domains to your workers
Refer to the official [documentation](https://developers.cloudflare.com/workers/configuration/routing/custom-domains/) for adding custom domains to your workers
### 5. Environment Variables
Set environment variables in the
[Cloudflare Workers dashboard](https://developers.cloudflare.com/workers/configuration/environment-variables/) or using
Wrangler:
Set environment variables in the [Cloudflare Workers dashboard](https://developers.cloudflare.com/workers/configuration/environment-variables/) or using Wrangler:
```bash
wrangler secret put API_KEY
wrangler secret put DATABASE_URL
```
> **Note:** `wrangler.toml` is not ignored in the `.gitignore`, so if you add environment variables for your deployment,
> they will be committed to version control. Make sure to remove them before pushing to a public repository.
> **Note:** `wrangler.toml` is not ignored in the `.gitignore`, so if you add environment variables for your deployment, they will be committed to version control. Make sure to remove them before pushing to a public repository.
### 6. Enjoy!