ghost-user-maker/README.md

50 lines
2.2 KiB
Markdown
Raw Permalink Normal View History

# Ghost User Maker
2022-08-05 00:17:26 -04:00
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.
2022-08-05 00:17:26 -04:00
## I just want to add my authors!
2022-08-05 00:17:26 -04:00
That's simple! Use the final product at the following link: https://ghost-user-maker.code.snipettemag.com
2022-08-05 00:17:26 -04:00
## Development
2022-08-05 00:17:26 -04:00
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:
2022-08-05 00:17:26 -04:00
```bash
yarn install
yarn dev
2022-08-05 00:17:26 -04:00
```
This will start up a live-reload development server at `http://localhost:8080` which you can access from your browser.
2022-08-05 00:17:26 -04:00
### Deployment
2022-08-05 00:17:26 -04:00
When you're done with coding and ready to deploy, simply run the following command:
2022-08-05 00:17:26 -04:00
```bash
yarn build
2022-08-05 00:17:26 -04:00
```
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:
2022-08-05 00:17:26 -04:00
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.
2022-08-05 00:17:26 -04:00
### Contributing
2022-08-05 00:17:26 -04:00
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!
2022-08-05 00:17:26 -04:00
## Credits
2022-08-05 00:17:26 -04:00
- This project is powered by [Svelte](https://svelte.dev/) and created using the template at https://github.com/sveltejs/template.
- Icons courtesy [FontAwesome](https://fontawesome.com) via the [fa-svelte](https://github.com/alphapeter/fa-svelte) NPM module
2022-08-26 08:28:07 -04:00
- The favicon is also from FontAwesome, but generated using Florian Gauger's [fonticon tool](https://gauger.io/fonticon/)
2022-08-26 08:21:03 -04:00
This project is licensed under the GPL version 3 (or later). See the LICENSE file for details. If you want to use this software under a different license instead, feel free to raise an issue and we'll get in touch.