pattimcletchie/codethesaur.us

Website to help you learn a new language from a language you already know! codethesaur.us

codethesaur.us

Website that will compare language features side by side.

Why would you want this?

Good question. If there's an aspect of a language you don't know, you can compare a languages you know with a language you do. It's a good way to quickly learn a new language, or use it as a quick reference to remember things by.

Requirements

• Python 3.x
• Django 3.11

If you run python --version and it shows Python 2.x but you know you have Python 3.x installed, you may need to suffix all python and pip commands with 3, e.g. pip3 and python3, or follow the process for making Python 3 your default Python installation.

Cloning and running it locally

Windows

1. Clone the project (git clone https://github.com/codethesaurus/codethesaur.us.git)
2. Switch into to directory cd codethesaur.us
3. Check to see if Python 3.x is installed with python --version or python3 --version. If Python 3.x isn't installed, visit https://www.python.org/downloads/windows/ or install it with choco install python
4. Install Python's virtual environment venv with the command pip3 install virtualenv
5. To set up new virtual environment, run virtualenv venv
6. To activate virtual environment, run venv\Scripts\activate.bat
7. Run pip install -r requirements.txt
8. Then Run python manage.py runserver
9. In your browser, visit http://127.0.0.1:8000/ or http://localhost:8000/
10. Press CTRL+C in the terminal to stop the server
11. To deactivate the virtual environment, run venv\Scripts\deactivate.bat

Mac

1. Check to see if Python 3.x is installed with python --version or python3 --version. If Python 3.x isn't installed, install it with brew install python
2. Clone the project (git clone https://github.com/codethesaurus/codethesaur.us.git)
3. Switch into to directory cd codethesaur.us
4. Run pip3 install virtualenv
5. To set up new virtual environment, run virtualenv --no-site-packages venv
6. To activate virtual environment, run source venv/bin/activate
7. Run pip3 install -r requirements.txt
8. Then Run python3 manage.py runserver
9. In your browser, visit http://127.0.0.1:8000/ or http://localhost:8000/
10. Press CTRL+C in the terminal to stop the server
11. To deactivate the virtual environment, run deactivate

Linux

1. If python3 and pip3 are not installed there is a guide for Linux systems
2. Check system default python --version If the returned text is not python 3.x then using python3 will be required for following steps Or if you would like to set python3 as a default simply open your .bashrc file. sudo nano ~/.bashrc and add alias python='python3'
3. Django 3.11 can be installed using the pip3 package manager. pip3 install django==3.11
4. Install venv for virtual environment sudo apt install -y python3-venv - Debian Full python3 and venv setup centOS
5. Clone the project (git clone https://github.com/codethesaurus/codethesaur.us.git)
6. Switch into to directory cd codethesaur.us
7. Use directory as virtual environment python3 -m venv codethesaur.us
8. Activate the directory source codethesaur.us/activate
9. Run pip install -r requirements.txt
10. Then run python manage.py runserver
11. In your browser, visit http://127.0.0.1:8000/ or http://localhost:8000/
12. Press CTRL+C in the terminal to stop the server.

Contributing

Check out the Contributing Guide to learn more about how you can help add more language data, fix bugs, or add features!

Code of Conduct

All contributors are required to follow the Code Thesaurus Code of Conduct.

Questions?

Preferred: Reach out on Twitter @codethesaurus

You could also email the core team ([email protected]).