|
1 | 1 | # Billsplit
|
2 | 2 |
|
| 3 | +<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> |
| 4 | + |
| 5 | +[](#contributors-) |
| 6 | + |
| 7 | +<!-- ALL-CONTRIBUTORS-BADGE:END --> |
| 8 | + |
3 | 9 | _Split your travel expenses easily_
|
4 | 10 |
|
5 |
| -Try it now: https://billsplit-project.vercel.app/ |
| 11 | +Try it now: https://billsplit-project.netlify.app/ |
6 | 12 |
|
7 | 13 | [](https://app.netlify.com/sites/billsplit-project/deploys)
|
8 | 14 |
|
@@ -34,69 +40,26 @@ Want to suggest a feature? Feel free to [Open an issue](https://github.com/Balas
|
34 | 40 |
|
35 | 41 | This application is born as a playground to learn [Qwik](https://qwik.builder.io/), if you're learning it too, feel free to contribute!
|
36 | 42 |
|
37 |
| -All intructions can be found in the [CONTRIBUTING.md](CONTRIBUTING.md) file. |
38 |
| - |
39 |
| -## Netlify |
40 |
| - |
41 |
| -This starter site is configured to deploy to [Netlify Edge Functions](https://docs.netlify.com/edge-functions/overview/), which means it will be rendered at an edge location near to your users. |
42 |
| - |
43 |
| -### Local development |
44 |
| - |
45 |
| -The [Netlify CLI](https://docs.netlify.com/cli/get-started/) can be used to preview a production build locally. To do so: First build your site, then to start a local server, run: |
46 |
| - |
47 |
| -1. Install Netlify CLI globally `npm i -g netlify-cli`. |
48 |
| -2. Build your site with both ssr and static `npm run build`. |
49 |
| -3. Start a local server with `npm run serve`. |
50 |
| - In this project, `npm run serve` uses the `netlify dev` command to spin up a server that can handle Netlify's Edge Functions locally. |
51 |
| -4. Visit [http://localhost:8888/](http://localhost:8888/) to check out your site. |
52 |
| - |
53 |
| -### Edge Functions Declarations |
54 |
| - |
55 |
| -[Netlify Edge Functions declarations](https://docs.netlify.com/edge-functions/declarations/) |
56 |
| -can be configured to run on specific URL patterns. Each edge function declaration associates |
57 |
| -one site path pattern with one function to execute on requests that match the path. A single request can execute a chain of edge functions from a series of declarations. A single edge function can be associated with multiple paths across various declarations. |
58 |
| - |
59 |
| -This is useful to determine if a page response should be Server-Side Rendered (SSR) or |
60 |
| -if the response should use a static-site generated (SSG) `index.html` file instead. |
61 |
| - |
62 |
| -By default, the Netlify Edge adaptor will generate a `.netlify/edge-middleware/manifest.json` file, which is used by the Netlify deployment to determine which paths should, and should not, use edge functions. |
63 |
| - |
64 |
| -To override the generated manifest, you can [add a declaration](https://docs.netlify.com/edge-functions/declarations/#add-a-declaration) to the `netlify.toml` using the `[[edge_functions]]` config. For example: |
65 |
| - |
66 |
| -```toml |
67 |
| -[[edge_functions]] |
68 |
| - path = "/admin" |
69 |
| - function = "auth" |
70 |
| -``` |
71 |
| - |
72 |
| -### Addition Adapter Options |
73 |
| - |
74 |
| -Netlify-specific option fields that can be passed to the adapter options: |
75 |
| - |
76 |
| -- `excludedPath` this option accepts a `string` glob pattern that represents which path pattern should not go through the generated Edge Functions. |
77 |
| - |
78 |
| -### Deployments |
79 |
| - |
80 |
| -You can [deploy your site to Netlify](https://docs.netlify.com/site-deploys/create-deploys/) either via a Git provider integration or through the Netlify CLI. This starter site includes a `netlify.toml` file to configure your build for deployment. |
81 |
| - |
82 |
| -#### Deploying via Git |
83 |
| - |
84 |
| -Once your site has been pushed to your Git provider, you can either link it [in the Netlify UI](https://app.netlify.com/start) or use the CLI. To link your site to a Git provider from the Netlify CLI, run the command: |
85 |
| - |
86 |
| -```shell |
87 |
| -netlify link |
88 |
| -``` |
| 43 | +All instructions can be found in the [CONTRIBUTING.md](CONTRIBUTING.md) file. |
89 | 44 |
|
90 |
| -This sets up [continuous deployment](https://docs.netlify.com/site-deploys/create-deploys/#deploy-with-git) for your site's repo. Whenever you push new commits to your repo, Netlify starts the build process.. |
| 45 | +## Contributors ✨ |
91 | 46 |
|
92 |
| -#### Deploying manually via the CLI |
| 47 | +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): |
93 | 48 |
|
94 |
| -If you wish to deploy from the CLI rather than using Git, you can use the command: |
| 49 | +<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> |
| 50 | +<!-- prettier-ignore-start --> |
| 51 | +<!-- markdownlint-disable --> |
| 52 | +<table> |
| 53 | + <tbody> |
| 54 | + <tr> |
| 55 | + <td align="center" valign="top" width="14.28%"><a href="https://leonardomontini.dev/"><img src="https://avatars.githubusercontent.com/u/7253929?v=4?s=100" width="100px;" alt="Leonardo Montini"/><br /><sub><b>Leonardo Montini</b></sub></a><br /><a href="https://github.com/DevLeonardoCommunity/billsplit/commits?author=Balastrong" title="Code">💻</a> <a href="#projectManagement-Balastrong" title="Project Management">📆</a></td> |
| 56 | + </tr> |
| 57 | + </tbody> |
| 58 | +</table> |
95 | 59 |
|
96 |
| -```shell |
97 |
| -netlify deploy --build |
98 |
| -``` |
| 60 | +<!-- markdownlint-restore --> |
| 61 | +<!-- prettier-ignore-end --> |
99 | 62 |
|
100 |
| -You must use the `--build` flag whenever you deploy. This ensures that the Edge Functions that this starter site relies on are generated and available when you deploy your site. |
| 63 | +<!-- ALL-CONTRIBUTORS-LIST:END --> |
101 | 64 |
|
102 |
| -Add `--prod` flag to deploy to production. |
| 65 | +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! |
0 commit comments