diff --git a/README.md b/README.md index 15616f2..21976bb 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,76 @@ -# sv +[![Moocup banner](/static/og.webp)](https://moocup.jaydip.me/) -Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli). +# What? -## Creating a project +A visual editor to create stunning screenshots. you can simply drop your screenshot, a base style will be applied. -If you're seeing this, you've probably already done this step. Congrats! +style it however you wish, and export. -```sh -# create a new project -npx sv create my-app -``` +that's basically it. -To recreate this project with the same configuration: +## Support -```sh -# recreate this project -pnpm dlx sv@0.12.5 create --template minimal --types ts --add prettier eslint tailwindcss="plugins:none" sveltekit-adapter="adapter:vercel" devtools-json --install pnpm ./ -``` +moocup is completely free to use. and is maintained by myself. -## Developing +If you wish to provide moocup a better future, +you can do so at [Ko-fi](https://ko-fi.com/jaydipsanghani) -Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: +You can also help me out by [contributing](#contributing). -```sh -npm run dev -# or start the server and open the app in a new browser tab -npm run dev -- --open -``` +[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/J3J41GWDRD) + +## Motivation + +I needed good visuals for my portfolio. I am a big fan of simple & functional things, but all the available options, didn't felt quite right to me. + +so, i made one myself. + +## Feature Request + +Raise a Issue with title "Feature Request : " and what you wish to see to be added in app. + +currently, I'm planning to only add features that gives more benefit to moocup as a tool. so, priority will change based on value. + + +## Self-hosting +You can easily self-host moocup on platforms like Vercel, Railway, or Netlify—just provide the repository and follow the standard steps to deploy a web app. -## Building +### One-click Railway Deploy: -To create a production version of your app: +[![Deploy on Railway](https://railway.app/button.svg)](https://railway.com/deploy/moocup?referralCode=bmgbXt) + + - for the latest version in a single click. -```sh -npm run build +### Docker Image + +You can also run moocup using Docker from Docker Hub: +``` +docker pull jellydeck/moocup:latest +docker run -p 8080:80 jellydeck/moocup:latest +``` +- app will be available at http://localhost:8080 + +### Manual Hosting: + +- Clone the repository. +- Build the project just like any other Vite app: + +``` + npm install + npm run build ``` -You can preview the production build with `npm run preview`. +- Upload the dist folder to your hosting provider (or attach it to a public URL) to make it accessible online. + +That’s it - you’ve got your own moocup instance running! + +## Contributing + +Contributions and Fixes are more than Welcome. +Raise a PR with relevant details, and it'll be merged + + +## License -> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment. +GNU AGPLv3