/Molecule-Name-Generator

A website where you can find a molecule name from its formula

Primary LanguageHTML

Molecule Name app

A web app made in flask hat let you find the name of an inorganic molecule from its formula

the website is available in french and english

Installation

To set up and run the project locally, follow these steps:

Prerequisites

Make sure you have the following installed

  • Python 3.x
  • pip (Python package manager)
  • A virtual environment tool (optional but recommended): For example: venv (included with Python) or virtualenv.

1. Clone the repository

Clone the repository to your local machine using:

git clone https://github.com/Rayanlupo/Molecule-Name-Generator.git

2. Set up the virtual environment

  • On Linux/Mac
python3 -m venv venv
source venv/bin/activate
  • On Window
python -m venv venv
venv\Scripts\activate

3. Install Dependencies

Install the required Python packages using pip:

pip install -r requirements.txt

5. Run the application!

Start the developer server in the terminal using:

flask run

Contributing

Pull requests are welcome. For major changes or bugs, please open an issue first to discuss what you would like to change or fix.

Please make sure to update tests as appropriate.

License

MIT

MIT License

Copyright (c) 2024 Guebre Nadir Rayane

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.