/writing-hat-api

Primary LanguageJavaScript

Writing Hat API

Add description here...

Requirements

For development, you will only need Node.js and a node global package, Yarn, installed in your environement.

Node

  • Node installation on Windows

    Just go on official Node.js website and download the installer. Also, be sure to have git available in your PATH, npm might need it (You can find git here).

  • Node installation on Ubuntu

    You can install nodejs and npm easily with apt install, just run the following commands.

    $ sudo apt install nodejs
$ sudo apt install npm

  • Other Operating Systems

    You can find more information about the installation on the official Node.js website and the official NPM website.

If the installation was successful, you should be able to run the following command.

$ node --version
16.13.1

$ npm --version
8.17.0

If you need to update npm, you can make it using npm! Cool right? After running the following command, just open again the command line and be happy.

$ npm install npm -g

Install

$ git clone https://github.com/tkazi/writing-hat-api
$ cd writing-hat-api
$ npm install

Configure app

Add Config steps

Running the project

$ npm start

Simple build for production

$ npm build

Contributors

👤 Taha Kazi

👤 Rao Akif

🤝 Contributing

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

  • Original design by Taha Kazi's Creative Hat.

  • Thanks to my peers who are always there to offer support.

  • Contributions, issues, and feature requests are welcome!

  • Feel free to check the issues page.

📝 License

This project is MIT licensed.