Skip to content

Latest commit

 

History

History
429 lines (265 loc) · 16.4 KB

Changelog.md

File metadata and controls

429 lines (265 loc) · 16.4 KB
Raw

← Docs

TheOpenCMS weekly report

Week 15

Hello World!

On this week I've done some improvements in the code. I'm going to make code of user_room and the_publication gems consistent.

We added indices to Article model but there is no UI for it now. We're going to add it soon.

Also I need to provide edit UI for Articles.

TheOpenCMS. Content is Everything!

See you next week!

Week 14

Hello World!

Content is Everything!

We added a functionality for publishing part. Now we can process Markdown markup and add code samples into a content of pages.

We have 2 video meetings every week with my assistants where I try to explain main parts of TheOpenCMS. We're going to add some tests to SimpleSort engine.

TheOpenCMS. Content is Everything!

See you next week!

Week 13

I'm working on the_publication gem. There is a lot of work.

I've reworked a structure of the project. Now we have the following structure for important components of the system:

Tools/
├── DeployTool
├── ServerSetup
└── scripts
Gemfiles
├── TheOpenCMS.rb
├── app_base.rb
├── application.rb
├── content.rb
├── databases.rb
├── delayed_jobs.rb
├── development.rb
└── user_room.rb
Engines/
├── apps
│   ├── app_base
│   ├── the_publication
│   ├── theopencms.org
│   └── user_room
└── tools
    ├── authorize_it
    ├── crop_tool
    ├── friendly_id_pack
    ├── image_tools
    ├── log_js
    ├── notifications
    ├── pagination
    ├── protozaur
    ├── simple_sort
    ├── the_string_addon
    ├── the_string_to_slug
    └── voiceless

We started video meetings with guys who are interested with my project. During video calls we're discussing the project, project's structure and related topics. Hope it will give some results.

TheOpenCMS. Content is Everything!

See you next week!

Week 12

I found a guy who is ready to help with testing. I'm going to pay some time to show the project to him and explain main concepts. I hope he will help me with the project.

Also I started working on content-oriented part of the project. I've called my new Engine the_publication. It will be responsible for all publication functionality.

I've created first simple rails generator to build so much publication models as I want. For example I'm going to have models like article, post, recipe, repost and so on. All models will provide the same functionality with possibility to extend each specific model with any custom functionality.

TheOpenCMS. Content is Everything!

See you next week!

Week 11

Nothing new. Was busy.

Week 10

Nothing new. Was busy.

Week 9

Hello World!

Content is Everything!

This week I updated some gems on the project. Now it uses:

  • Rails 5.1
  • Sidekiq 5.0

This week I added:

  • autoprefixer-rails gem to the project to improve CSS for different browsers. Also I've found a small issue in autoprefixer-rails and going to prepare small PR for this gem soon.

  • I18n-tasks gem to the project to improve work with locale files. Unfortunately this nice gem can't recognize some cases in my code like some self-written helper-wrappers in Controllers. I'm talking about cases like

    def _t(name, options)
  t(name, options.merge(scope: 'some_scope'))
end

Plans for the next week

I'm close to start development of the content-based part of the project. I wish I had some time for that.

TheOpenCMS. Content is Everything!

See you next week!

Week 8

Hello World!

Content is Everything!

Almost all week I spent on vacation in Istanbul. It was a great time. Really nice city. Really great culture!

Anyway I found some time during my flight to home to improve my prject.

First of all I'm glad to introduce a new authorization solution for TheOpenCMS! With the new gem AuthorizeIt I provided a common API for authorization actions and to extract Strong parameters into separated classes for an each action.

I'm absolutely sure Rails team does filtering of parameters with not a best way. Rails controllers have to know noting about how to filter incoming parameters from users. That is why since now all my engines will have a special folder app/permissions to provide authorization staff and filtering of parameters.

Also I've updated the Index page of the project. Now you can see a small notification block at the bottom of the Index page. This block shows a data about recent deployed code on the production server.

Plans for the next week

Next week I'm going to spend on bug fixing and some refactoring of the code.

TheOpenCMS. Content is Everything!

See you next week!

Week 7

Hello World!

Content is Everything!

Last week I've published the first early release v0.1 of TheOpenCMS, also I've launched a web site https://theopencms.org for the project.

As I wrote it in the previous report just a simple user's profile functionality was ready on the last week.

Right after the release I've got a really helpful report from @karthickrajak about an issue with access permissions.

Well, really I've totally forgot about any restrictions and I had to fix it ASAP. So, if you think I used something like cancan or cancancan then you are wrong. I'm going to implement authorization system from the scratch. Actually I've already finished a first simple implementation. I have some experience with authorization systems and I'm pretty sure it I can implement this kind of functionality myself.

Anyway, great thanks to @karthickrajak and to people who signed up to check how a user's profile functionality works.

Since this week I have a short vacation and I'm not sure I'll have enough time to implement or improve something during the next week. I'm just going to have a good rest.

Have a good week! See you soon.

TheOpenCMS. Content is Everything!

Week 6

Hello World!

Content is Everything!

  • I reworked some parts of the code and changed a structure of the project.
  • I added a simple DeployTool to the Project.
  • I've finished all preparations and launched the website for the project. TheOpenCMS.org is available!

Plans for the next week

I'm going to improve an existing code base and test everything what I have for the current moment. When everything is done I start development of a Content Management functionality.

How to help

  • Now it's possible to check how the website TheOpenCMS.org works and create an issue on GitHub if any bug is found.
  • Feel free to give a star to the project.
  • It's always possible to improve localization and current translations.

TheOpenCMS. Content is Everything!

See you next week!

Week 5

Hello World!

Content is Everything!

On this week I've done the following things:

  • Login via Social Networks was debugged. Works fine.
  • User can connect multiple Social Accounts to own Profile
  • I've described how to get OAuth tokens for some social networks. New page was added in docs folder.
  • Index/Show pages for Users controller were improved
  • Some improvements were done
  • File structure of the project was changed

Login via Social Networks

Index/Show pages

Plans for the next week

I'm going to setup a server and launch the project.

How to help

  • Feel free to give a star to the project. Your support is very important
  • It's always possible to improve localization and improve current translations.

TheOpenCMS. Content is Everything!

See you next week!

Week 4

Hello World!

Content is Everything!

On this week I improved gem 'user_room'. Now gem provides all basic actions. User is able to sign in/login, update profile's data, and to see a list of users.

There is a basic user's story with screenshots:

User

  • is able to Sign in/Login in the system with email
  • receives an email with activation link or a one-time login link
  • sees a user's profile
  • is able to update a profile's data: Name, Login, About, Social Networks addresses, etc.
  • uploads and crops an avatar image
  • is able to see a list of users

Plans for the next week

  • I'm going to start debugging Login via Social Networks workflow.

How to help

  • Feel free to give a star to the project. Your support is very important
  • It's always possible to improve localization and improve current translations.

TheOpenCMS. Content is Everything!

See you next week!

P.S.: Btw, I've bought already a domain name theopencms.org. I'm going to start a web site soon(...ish).

Week 3

Hello World!

Content is Everything!

First of all I want to say Thank you to people who already supported the project with their stars. Your stars are very important!

During this week I was working on improvements for a few parts of the project.

notifications gem was improved, but it still needs for some improvements. I'll do it later when I meet a real cases and problems.

There are some screenshots how gem notifications renders notifications:

Most of the time I was working on gem user_room. I improved localizations, mailer, mailer's templates.

There are some examples how mailer's templates look

I collected all the mailer's staff (css, mailer's classes, templates) in the only folder app/mailers. If you are interested how I've done it you may check this file

Also small gem log-js was improved.

Also I was playing with Turbolinks. I'm going to use it later, but right now I don't have enough cases to use it somehow.

I've created a channel in gitter.im - gitter.im/the_open_cms. Feel free to ask anything about the project TheOpenCMS.

Plans for the next week

  • I'm going to start debugging Login/Sign-in workflows.

How to help

  • Feel free to give a star to the project to show you interest to this initiative.
  • You can take a look at localizations files. I'm not a native speaker and I'm sure there are a lot of things to improve.
  • Feel free to ask me about the project in the new channel gitter.im/the_open_cms

TheOpenCMS. Content is Everything!

See you next week!

Week 2

Hello World!

Content is Everything!

A week ago I've started to make my own CMS project on Rails 5.

Why do I do that? I believe - Content is Everything! And we (developers, community) have to provide a diversity of CMS projects on the Web. Unfortunately, I've noticed that Rails eco-system doesn't have enough CMS projects. All great developers are concentrated on something else, and many people around think that a CMS is something what easy to create and it doesn't worth to pay an attention to this area. I'll try to change something.

I'm going to create my CMS based on Rails Engines. First of all I have to create an Engine for a user's profile. This engine will provide Sign in and Login process, some user's profile staff like avatar uploading, a profile's edit page and so on.

On this week I've done the following things:

  • Cleaned up the code of the user_room gem

  • Added some docs in the Docs folder

  • Added translation files and provided I18n for user_room gem

  • Sprockets didn't compile my Engine's assets as they have to. I found a solution. Just use a code from the current mater branch.

  • The first page of user_room gem started to work. Now it looks so:

Plans for the next week

  • I'm going to proceed making improvements for user_room gem. It will take some time to make it work properly
  • I have to improve gem notifications and to make it work properly with user_room gem

How to help

  • If you want to help you can try to improve translation files for user_room gem locale files
  • Fell free to give a star to the project TheOpenCMS

TheOpenCMS. Content is Everything!

See you next week!

Week 1

Hello World! Content is Everything!

This week I've decided to create a new CMS on Rails 5. Actually I already have some code drafts and ideas about how my CMS has to work, and I think this time I'll reach my goal.

First of all I had to decide how I would split my CMS into the parts and how I would manage all this staff.

I choose git subtrees to manage dependencies in my project. With subtrees I can keep all the code in a one place and I will manage the only one repo, however I can update each dependance separately. I was confused with --squash option on the git subtree pull command. I don't like how this option works. And that's why I will not use it.

I've created a small ruby script to work with subtree commands. During the development process I do something like this:

ruby SUBTREES/subtree.rb add  the_open_cms

ruby SUBTREES/subtree.rb pull the_open_cms

ruby SUBTREES/subtree.rb push the_open_cms

With these commands I can add, pull, push all dependencies at the same time. Right now it works fine for me.

Gems were published

This week I've already published a few small but helpful gems. They will be used when I'll be implementing User's cabinet. There is the list of these gems:

  • voiceless very small gem helps split system in to the parts.
  • log_js very small gem provides a shortcut method log for method console.log.
  • pagination very small gem provides a helper for Kaminari pagination.
  • simple_sort small gem provides a few sort helpers for AR models.
  • image_tools small gem provides a few helpers for image manipulations.
  • crop_tool small gem provides a crop tool for Images.
  • notifications small gem provides a helper to show flash notifications in a Rails app.

Goals

My first goal is to create a user's cabinet (user registration & user profile). On the first step I will implement signing by email and most popular social networks. Also I have to implement avatars' uploading and maybe some email notifications. Not sure right now. We will see.

Current status

The app still doesn't work. There are a lot of things to do, but I know what I have to finish to make it alive. Wish me good luck :)

TheOpenCMS. Content is Everything!

See you next week!