A NodeJs API made with Express.js for parsing and working with PSD files.
At first, i've created this API to use on a single project made with Fabric.js and HTML Canvas in a specific use case (I need to upload a PSD file and parse it in my Canvas project). But while i'm developing this I see a lot of potential in this project and I decided to share on a individual to expand and add more features to help the community with image manipulate tools. Feel free to contribute and help this idea to grow in something really good!
This project is under development, and the future updates is focusing on the following features.
-
Create a first endpoint "/api/psd/parse-layers" that accepts a PSD file and return a array with all layers in a JSON format
-
A endpoint "/api/remove-bg" to remove images background.
- Node.js 20.10.0
The project does not yet have a oficial production deployment. But you can start it on your local machine follow this steps:
- Clone the repository
git clone https://github.com/omatheusant/photo-reader-api.git
- Enter the repo directory
cd ./photo-reader-api/
- Install the projects dependencies
npm install
- Run the project!
npm run dev
If is all right, the message Server is running at http://localhost:3001 will be displayed in the console.
To contribute with the Photo Reader API, follow this steps!
- Fork this repository.
- Create a branch:
git checkout -b <branch_name>. - Make your changes and confirm it:
git commit -m '<commit_message>' - Send to the original branch:
git push origin psd-reader / <local> - Make a pull request.
You can also check the Github Documentation of how colaborate with issues and pull requests
Want to make part of this project? Feel free to contribute with issues, pull requests or insights and you'll appears on the contributors list
This project is under license, please read LICENSE for more details.