Hey there,

This pull request is essentially here to setup a documentation workflow base on jsDoc, and also to setup the Database Cleanup System ( issue #109 ).

Please go and check it out, and let me know your thoughts

Thanks in advance Massiles.

Current situation.

While refactoring the code, I've read the routes files a couple times, and I've clearly seen that the API Routes are not setup correctly. In other word, how our API behaves is not quiet good.

For example:

As we can see in this one, we are using the same controller for the GET and the POST requests.

Also, we do not need the two ids in the route to follow a user or unfollow one. Since, the only user that can perform these tasks is the one that is currently using the platform, with that been said, this user will be always known by our server. So, is making his id on the url necessary ?.

Same thing goes with the /block/ routes, regarding the POST requests.

Finally, I think that designing great API routes is very important, since it keeps the development and the scalability of the platform easier to achieve, same thing regarding the security aspect.

Todo

• [x] Design Better API Routes.
• [x] Adapt to this new Route signature.
• [x] Inform the front-end team, to update their API calls.

Please refer to me if something is wrong.

Hope that is clear. Massiles.

Idea

Users are a difficult part of programming because there are always bad users. Email verification stops users from creating spam accounts and it also lets us determine where groups of spam accounts may be. This is why we need a system for users to verify their emails.

Todo

• [x] Send Verification Email to Users
• [x] Add Email Bool to User in Database
• [x] Restrict User from Actions Until Email is Verified

Idea

We have a huge codebase at this point and it keeps on growing in size. So, what do we need to do? Add more documentation. If we do this, we will enable new contributors to add code to the project, and we can keep growing.

If you want to do this, leave a comment, and I will assign you to the issue!

Cheers!

Todo

• [ ] Setup a Build System for Documentation using Github Pages

Idea

Comments are supposed to improve readability and make it easier to reason about the code. Currently there are a lot of comments that are redundant. There is no sense in commenting a function if its name clearly describes its purpose. There is no sense in commenting blocks of code in a large method, it is much better to extract them into their own functions.

Todo

• If you see a comment that doesn't add important information, please remove it.
• If you want to comment something, please consider another way of communicating what you're trying to achieve.

Idea

Since, we've created the email verification system, and it appears to be working, we need to create a system that will delete all the user records in our database with the email_confirmed attribute set to false for the past 30 days or so !

Basically, we need to get rid of the user's accounts that did not confirmed their email addresses a while ago , because they are considered inactive.

Why should we implement this system

• Gain in Database Storage & Performance.
• Optimize our Audience by Selecting a Highly Active User Base.
• Push the Users to be Active.

Let me know your thoughts guys, and feel free to suggest and discuss down below !

Hope that is clear ! Massiles.

Todo

• [x] Create a node module, where we can fetch our user records and see the creation date.
• [x] Create a deletion algorithm that will delete all the related data and activity to the outdated user records.
• [x] Wrap this module in an interval ( use the setInterval Time Api function )
• [x] Execute it & test it .

Idea

Right now, the FPA is a fairly young open-source organization that needs help to grow. To do this, we need to get our name heard, so we need someone who is not yet a contributor to our project to help out by creating a pull request on the 'github/explore' repo. Just add the 'fairfield-programming/fairfield-programming.github.io' to this file, and you have helped the FPA immensely.

This file is a list of Github Pages examples, which our repo is.

Todo

• [ ] Add our website repo to the 'open-source-organizations' Readme file

Right now there are a couple of hats and eyes that users can add to their ducks, but we need more options.

If you have any ideas for things you want to be added to the ducks, leave a comment below!

Idea

The RSVP system should allow users to subscribe to events. This subscription will say that a user is going to go to a certain event. The user should not be able to subscribe to the event if they are not eligible to (I.E, the event is for delegates but the user isn't one). The users will then be notified of any changes to the event or anything that the event hosts would like the users to know.

Todo

• [x] Allow Users to Subscribe to an Event
• [x] Block Users from Subscribing if not Eligible
• [x] Add Email Alerts for the Event
• [x] Allow Users to Unsubscribe from an Event

Idea

Since, we've created the email verification system, and it appears to be working, we need to create a system that will remind the users to confirm their email addresses before our Database Cleanup System #109 delete their accounts.

Basically, we need to send a second email to the users with an email address that is not confirmed within the first 14 days of their registration. If they do not confirm it, within the next 14 days, our Database Cleanup System #109 will remove their account.

Benefits

The whole point of this is to remind our users to confirm their email address so as they can access all our platform services. Basically, give them a better UX.

Todo

• [x] Create a new node module.
• [x] Fetch the user record with confirmed_email=false and createdAt=14_DAYS_AGO.
• [x] Send to them a new email, like the one we sent to them when they signed up, but with a different token.
• [x] Wrap this feature in a cron schedule, and fire it up every 14 days or so.
• [x] Execute it & test it.

Hope that is clear, and please let me know if something is wrong. Massiles.

Idea

I think it is incredibly difficult to grow the codebase. Refactoring is very frustrating because the same steps need to be applied for several files. We are going to experience maintenance Hell if we won't at least keep the duplication at the current level.

Idea

Hi, me and my friend @MargotRasamy would like to add a docker-compose file to facilitate the deployment of the project.

Todo

• [ ] Create docker-compose file in root of this project
• [ ] Create Service backend-server

Hey there everyone !

With this PR we can now read the posts within different routes.

We can read :

• All posts.
• Post by Id.
• All user's posts.
• One user's post by id.

Please refer to the code for more info.

Note:

This is built on top of the create PR. So to avoid merge conflicts please consider merging them by order or just merge the last one.

Also, you can notice on the code that I did not use our middelewares like verifyLogin or verifyEmail, I did so for simplicity sake and faster development. I will fire up a PR to add them after the Post system implementation.

Hope that is clear. Massiles.

With this new PR, we have now a Post modal setup and a createPost controller setup. This will be the first step on the implementation of the Post system.

Kind regards Massiles.

Idea

We want to run a competition, but we aren't going to be using tools like HackerRank. What we need is a system to create, run, and manage competitions in real-time. This system should be able to handle multiple competitions at once and should be fairly secure.

The competitions will look fairly similar to CodeQuest, and now that I am thinking about it, they should be their own microservice.

Please comment down below with a suggestion about what stack we should use, and if you would be interested in helping.

Idea

We will not be regarded as a reputable institution until we have a Wikipedia page written about us. To do this, we are just going to need to write it ourselves. Since a Wikipedia page cannot be written until there are two articles about the organization, we need to first complete issue #96. Once that is done, we can build away!

Todo

• [ ] Create a Wikipedia page about the FPA. The logo is under the Creative Commons Zero license, and all of the information you need to write the article can be found in #96.