Skip to content

Latest commit

 

History

History
118 lines (74 loc) · 3.92 KB

README.md

File metadata and controls

118 lines (74 loc) · 3.92 KB
Raw
Imagable's logo

Imagable

Build Web Build Server Lint Server Imagable's code quality badge

Imagable lets you generate icons automatically for different platforms.

Try it out Right now!

Getting Started 🤘

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites 👀

You would need

  • Node.js version that has Long Term Support (LTS) or v14+.
  • Git
  • Typescript We use typescript to scale our applications with type safety.

Installing 🚀

You would need npm to install our packages.

We have a simple shell script to install all packages to get you started.

Just run scripts/install.sh if you are on a UNIX/LINUX machine.

sh scripts/install.sh

Run scripts/install-win.ps1 if you are on windows.

.\scripts\install-win.ps1

This message will get your installation finished

Installation Success ✅

Running the tests ✅

For testing the server, you would need to build it first into Javascript. You can test the our Website by running npm start inside web directory.

Running Server tests

There are some few scripts inside the package.json in the server directory.

First you would need to run

npm run build

and to get the server up and running at the port 3000 or a specific port choosed by the system.

npm run test

Linting the code

We have configured husky so that everytime, you commit, it lints and formats the code.

We have configured eslint for our server codebase, but not for the web. This was a mistake while creating the software. We will fix it soon.

Run this to manually lint the code

sh scripts/lint-server.sh

or

cd server
npm run lint

Deployment 🔨

The branch forked by haneenmahd is used to deploy this project to production. See discussion for your questions discussion#42 💬.

Built With 🛠

Contributing 👋

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning 📦

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors 🧑‍💻👩‍💻

See also the list of contributors who participated in this project.

License ©

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments 🔖

We were inspired by the fact that it was somewhat hard to create icons for different platforms and we needed to make it as simple with one click!