Table of Contents
Tale.ink aims to change the way creative works are written and published. By moving book publishing to a more social media style approach, tale allows for writers to get faster feedback on their books. This makes book writing and publishing more agile. Additionally, the UI takes a more modern approach to facilitate a good reading and writing experience across all platforms
Follow these steps to run the project
This is an example of how to list things you need to use the software and how to install them.
- npm
npm install npm@latest -g
The current implementation uses secret firebase API keys. Testing features will require you to setup your own firebase account and put your keys in a .env.local file
- Clone the repo
git clone https://github.com/hbdermott/tale.git
- Install NPM packages
npm install
- To run in dev mode
npm dev - Or build and run
npm build && npm start
- Add Chapters
- Draft works
- User profile
- Avatar Image
- Username
- Current works
- Bio
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License.
Hunter Dermott - @your_twitter - hbdermott@gmail.com
Links: Tale.ink - hbdermott/tale