Video Demo: Video demo
This project was not intended to use as an assignment for CS50x, but it kills two birds with one stone. The purpose of this website is to use it as a biography of who I am, what's been done through my journey.
The application will create a new file called app.log, where Server information will be logged to control its behavior
The project uses HTML to structure the content of the web pages.
Cascade Style Sheets has been automaticly generated using Sass complier
Sass was used to style the web pages. Including RWD to ensure the webpage is viewable for various devices.
The JavaScript is used to add interactivity to the web site.
- Automated Slider (Non functional as im going to go over to a Instagram API later) is implemented for the carusel
During the planning, Flask was chosen as the web framework because of it's flexiblibility and ease of use. It provides the backend logic and API endpoints to fetch data from Github.
SQLite is used as the Database Management System.
It is lightweight and doesn't require a server, which makes it suitable for the project.
Please install the dependencies through the requirements.txt :
pip install -r requirements.txtCreate a .env file
# Tokens
GITHUB_TOKEN = "Bearer <Your Github Token>"To run the test, from the root of the repo
pytest -v
pytest --html=reports.htmlTests are based on the GITHUB REST API
test_connection During the connection test with the reposory i found out that i could expect agruments in the fields in the api, as a consequence of using Github REST API,it's reasonable to believe that if the request is Ok i will recieve the same output in expected and actual. Therefore it would be best practise to use the actual dictionary to pass values into the expected json, as the requests returns an json file if the code is 200, and to hide "sensitive information about a user.
moc_requests By mocking the url from GITHUB REST API i expect to find my repositories avialable
Tests are based on the documentation for unit tests test_insertion test_update
In order to visualize the test, i created a test report. So its easier to view the test of the programs.
flask, flask_session - by the pallets project pytest, sqlite, os - Python built in responsories dotenv - Saurabh Kumar
See the seperate file LICENCE
During the creation of the model some challanges with the API was encountered.
While fetching the API i encountered an issue that for everytime the program sends a GET request. The program fetches the whole repo I choose to create an intervaler in order to just fetch once a day or when there is something new in the Repo.
Filtering by language wasn't as easy as i expected, because of some strange bug in the system, i couldn't add a custom language to the list.
During the tests i learned alot about how to use Python's built-in pytest as unit testing network.
During the testing stage, raising exceptions durng the tests was learned.
I learned to test an API using requests and pytest repository i learned basic database testing using Unit testing repository
Testing the API function - Automated testing
During the tests i had to figure out a way to store the expected results with out sharing any sensitive information about the account. I chose to use the request to add the sensitive information, as i can expect that information to be added if the test should do succseed.Ensure the connection to the API.
During the tests of the API function i encounted a challange to test the API with out sharing any sensitive information about the account which was tested.
Testing the Database connection By testing the database connection, we can ensure that the database can be connected in a requested way
Testing the Exceptions While testing Exceptions, We can ensure the user to know what excatly went wrong under the operation Testing the request
Sincerely, @krigjo25