From c30e69c372498239986f7e83c2f06c02075961cb Mon Sep 17 00:00:00 2001 From: Badri Sunderarajan Date: Sat, 6 Aug 2022 03:22:45 -0700 Subject: [PATCH] Update README with actual information Just realised we had the project template's README in there, which, while not entirely useless, could definitely be improved upon --- README.md | 114 +++++++++++++----------------------------------------- 1 file changed, 26 insertions(+), 88 deletions(-) diff --git a/README.md b/README.md index 43e08d6..f46c153 100644 --- a/README.md +++ b/README.md @@ -1,107 +1,45 @@ -# This repo is no longer maintained. Consider using `npm init vite` and selecting the `svelte` option or — if you want a full-fledged app framework and don't mind using pre-1.0 software — use [SvelteKit](https://kit.svelte.dev), the official application framework for Svelte. +# Ghost User Maker ---- +This is a simple webapp that takes in an author's details and exports it in a format that can be imported to +[Ghost](https://ghost.org). It has been designed as a workaround to the fact that Ghost doesn't let you directly add authors +from the admin panel without going through the process of inviting them via email. -# svelte app +## I just want to add my authors! -This is a project template for [Svelte](https://svelte.dev) apps. It lives at https://github.com/sveltejs/template. +That's simple! Use the final product at the following link: https://ghost-user-maker.code.snipettemag.com -To create a new project based on this template using [degit](https://github.com/Rich-Harris/degit): +## Development + +Ghost User Maker is powered by [TypeScript](https://www.typescriptlang.org/) and [Svelte](https://svelte.dev/), with +[Yarn](https://yarnpkg.com) for dependency management. After cloning this repo, you can get it going using the normal +process: ```bash -npx degit sveltejs/template svelte-app -cd svelte-app +yarn install +yarn dev ``` -*Note that you will need to have [Node.js](https://nodejs.org) installed.* +This will start up a live-reload development server at `http://localhost:8080` which you can access from your browser. +### Deployment -## Get started - -Install the dependencies... +When you're done with coding and ready to deploy, simply run the following command: ```bash -cd svelte-app -npm install +yarn build ``` -...then start [Rollup](https://rollupjs.org): +The output will be saved to the `public/` directory, which can then be deployed to any ordinary static HTTP server. +That's right, there's no special backend process needed to keep this app running :wink: -```bash -npm run dev -``` +Similarly, if you want to deploy your site on a service like [Netlify](https://netlify.com), you can use `yarn build` +as the build command and `public/` as the directory to be published. -Navigate to [localhost:8080](http://localhost:8080). You should see your app running. Edit a component file in `src`, save it, and reload the page to see your changes. +### Contributing -By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the `sirv` commands in package.json to include the option `--host 0.0.0.0`. +Since this is a simple app, there's not much left to do, but if you feel there's something missing, contributions +would be welcome! Feel free to open an issue, comment, or pull request as appropriate. And, thanks in advance! -If you're using [Visual Studio Code](https://code.visualstudio.com/) we recommend installing the official extension [Svelte for VS Code](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode). If you are using other editors you may need to install a plugin in order to get syntax highlighting and intellisense. +## Credits -## Building and running in production mode - -To create an optimised version of the app: - -```bash -npm run build -``` - -You can run the newly built app with `npm run start`. This uses [sirv](https://github.com/lukeed/sirv), which is included in your package.json's `dependencies` so that the app will work when you deploy to platforms like [Heroku](https://heroku.com). - - -## Single-page app mode - -By default, sirv will only respond to requests that match files in `public`. This is to maximise compatibility with static fileservers, allowing you to deploy your app anywhere. - -If you're building a single-page app (SPA) with multiple routes, sirv needs to be able to respond to requests for *any* path. You can make it so by editing the `"start"` command in package.json: - -```js -"start": "sirv public --single" -``` - -## Using TypeScript - -This template comes with a script to set up a TypeScript development environment, you can run it immediately after cloning the template with: - -```bash -node scripts/setupTypeScript.js -``` - -Or remove the script via: - -```bash -rm scripts/setupTypeScript.js -``` - -If you want to use `baseUrl` or `path` aliases within your `tsconfig`, you need to set up `@rollup/plugin-alias` to tell Rollup to resolve the aliases. For more info, see [this StackOverflow question](https://stackoverflow.com/questions/63427935/setup-tsconfig-path-in-svelte). - -## Deploying to the web - -### With [Vercel](https://vercel.com) - -Install `vercel` if you haven't already: - -```bash -npm install -g vercel -``` - -Then, from within your project folder: - -```bash -cd public -vercel deploy --name my-project -``` - -### With [surge](https://surge.sh/) - -Install `surge` if you haven't already: - -```bash -npm install -g surge -``` - -Then, from within your project folder: - -```bash -npm run build -surge public my-project.surge.sh -``` +This project is created using the template at https://github.com/sveltejs/template.