commit 3900af5f9171bf4e62bf6551c10c5eb385c9b902 · comet.sh/comet

+20

LICENSE

···

       1
       1
       +
       MIT License

     

       2
       2
       +
       

     

       3
       3
       +
       Copyright (c) 2025 comet.sh

     

       4
       4
       +
       

     

       5
       5
       +
       Permission is hereby granted, free of charge, to any person obtaining a copy of

     

       6
       6
       +
       this software and associated documentation files (the "Software"), to deal in

     

       7
       7
       +
       the Software without restriction, including without limitation the rights to

     

       8
       8
       +
       use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of

     

       9
       9
       +
       the Software, and to permit persons to whom the Software is furnished to do so,

     

       10
       10
       +
       subject to the following conditions:

     

       11
       11
       +
       

     

       12
       12
       +
       The above copyright notice and this permission notice shall be included in all

     

       13
       13
       +
       copies or substantial portions of the Software.

     

       14
       14
       +
       

     

       15
       15
       +
       THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

     

       16
       16
       +
       IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS

     

       17
       17
       +
       FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR

     

       18
       18
       +
       COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER

     

       19
       19
       +
       IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN

     

       20
       20
       +
       CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE

+16 -32

README.md

···

       1
       1
       -
       # sv

     

       2
       2
       -
       

     

       3
       3
       -
       Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).

     

       4
       4
       -
       

     

       5
       5
       -
       ## Creating a project

     

       6
       6
       -
       

     

       7
       7
       -
       If you're seeing this, you've probably already done this step. Congrats!

     

       8
       8
       -
       

     

       9
       9
       -
       ```bash

     

       10
       10
       -
       # create a new project in the current directory

     

       11
       11
       -
       npx sv create

     

       12
       12
       -
       

     

       13
       13
       -
       # create a new project in my-app

     

       14
       14
       -
       npx sv create my-app

     

       15
       15
       -
       ```

     

       16
       16
       -
       

     

       17
       17
       -
       ## Developing

     

       18
       18
       -
       

     

       19
       19
       -
       Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:

     

       20
       20
       -
       

     

       21
       21
       -
       ```bash

     

       22
       22
       -
       npm run dev

     

       1
       1
       +
       # Comet

     

       23
       2
        
       

     

       24
       24
       -
       # or start the server and open the app in a new browser tab

     

       25
       25
       -
       npm run dev -- --open

     

       26
       26
       -
       ```

     

       3
       3
       +
       > Music on ATProto.

     

       27
       4
        
       

     

       28
       28
       -
       ## Building

     

       5
       5
       +
       Comet's goal is to provide an open, decentralised alternative for uploading and

     

       6
       6
       +
       sharing your music with others.

     

       29
       7
        
       

     

       30
       30
       -
       To create a production version of your app:

     

       8
       8
       +
       Follow along on Bluesky! [@comet.sh](https://bsky.app/profile/comet.sh) /

     

       9
       9
       +
       [@ovyerus.com](https://bsky.app/profile/ovyerus.com)

     

       31
       10
        
       

     

       32
       32
       -
       ```bash

     

       33
       33
       -
       npm run build

     

       34
       34
       -
       ```

     

       11
       11
       +
       This project is in the _very_ early stages and a lot will change over time,

     

       12
       12
       +
       especially as this is my first foray into the ATProtocol ecosystem. Stuff will

     

       13
       13
       +
       be a bit messy for a while. Feel free to contribute and voice your opinions!

     

       35
       14
        
       

     

       36
       36
       -
       You can preview the production build with `npm run preview`.

     

       15
       15
       +
       ## Current Status

     

       37
       16
        
       

     

       38
       38
       -
       > To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.

     

       17
       17
       +
       - [ ] Experimental Lexicons

     

       18
       18
       +
         - [x] Records

     

       19
       19
       +
         - [ ] Queries

     

       20
       20
       +
       - [ ] PoC Node/Bun AppView (eventually I want to rewrite in something like Rust

     

       21
       21
       +
             or Elixir. TBD)

     

       22
       22
       +
       - [ ] Clients