Skip to content

Latest commit

 

History

History
90 lines (52 loc) · 4.57 KB

exercise26.md

File metadata and controls

90 lines (52 loc) · 4.57 KB

Exercise 26 (Starting a project)

A project idea can make you procrastinate, do you believe that?

Do you also know that it is better to have a broad view of the project you want to build before you start coding? Of course, having a broad view of the project doesn't mean implement it at once.

Do you know that it is not, sometimes, the code that makes the project but the idea and documentation? Yes, what is an idea if it is just a paper project?

Do you know that your project does not have to necessarily rock the world? I mean, if you want to do something. Your project can be function implementations of some mathematical concepts. Your projects can just be the solutions (implementations) of some algorithm and data structure course.

We are telling you that, having an understanding of the programming concepts we have discussed so far and can use them is the whole purpose of this journey.

A project may fit into one file. It depends. You should know when to separate concerns (functionalities) and when to use a class. You can separate some functions in a new file. If some of these functions and data required can fit into a class, do that.

Get the project idea and write a story on it. This story will guide you on how you should implement the idea.

Virtual environment

Whenever we want to start a project, it is recommended that we use a virtual environment. A virtual environment separates the requirements we need for our particular project from the modules on our local system. With this approach, we can choose a version of a module that is unique to our project.

This will not affect the version of the local module if it exists. We recommend you use pipenv.

Project management

Github is one of the free servers that can host our project. You will have to create a Github repo for your project. This will allow others to contribute to your project. Again, if the unfortunate happens when you lose your PC, you still have the remote code available on Github.

Trello can be used as a management tool for your project. It is a very great tool for managing projects for a small number of devs also.

Unit test

There are instances whereby we have to take another step to develop an interface for some functionalities. There is no need for these extra step when is not needed. Write a unit test instead. Try and break your code and fix it.

Documentation

Every project must have a story. This story tells onlookers and stakeholders what your project does and sometimes the benefit it comes with. It tells users and other devs how to use your application and sometimes how to extend it.

Where to go from here

From here, try going through the resources below. (It is not compulsory). It is good for your programming health. The more you understand the better.

How to structure a project

More on virtual environments

More Projects for your elbow