https://github.com/nlpatvcu/findapi
https://github.com/nlpatvcu/findapi
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nlpatvcu/findapi
- Owner: NLPatVCU
- License: mit
- Created: 2018-04-11T16:54:07.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-14T18:14:10.000Z (about 8 years ago)
- Last Synced: 2025-03-16T21:49:23.596Z (about 1 year ago)
- Language: Python
- Size: 30.3 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# FiNDAPI
FiNDAPI is a API developed with the intention of being able to succesfully parse any scientific paper in a majority of the most common formats.
## 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
Install Python 3.6.5 if you do not have it. The download can be found [here](https://www.python.org/downloads/).
### Installing
Run the setup.py to install all the needed dependencies. It is best to do this in a virtual enviorment if possible.
```
python setup.py install
```
To start the server run the following commands:
```
cd FiNDAPI
python app.py
```
The server should now be running. Go to [http://localhost:8888](http://localhost:8888) to view the Swagger Documentation for use of the API.
## Running the tests
Explain how to run the automated tests for this system
## Deployment
Add additional notes about how to deploy this on a live system
## Built With
* [Python 3.6.5](https://www.python.org)
## Contributing
Please read [CONTRIBUTING.md](https://github.com/NanoNLP/FiNDAPI/blob/master/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Authors
* [**Brandon Watts**](https://github.com/brandonwatts)
See also the list of [contributors](https://github.com/NanoNLP/FiNDAPI/graphs/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/NanoNLP/FiNDAPI/blob/master/LICENSE) file for details
## Acknowledgments
* Bridget McInnes
* Nastassja Lewinski